实例列表
更新时间：2025-04-18
GET
http://{endpoint}/v{version}/vdb/instance/list
- 只能查看属于自己账号当前地域下有权限的实例列表
- 本接口为v1接口
权限说明
所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成，均为字符串。 对于每个HTTP请求，使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}。
- version是正整数。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
- signature是256位签名的十六进制表示，由64个小写字母组成。
当百度智能云接收到用户的请求后，系统将使用相同的SK和同样的认证机制生成认证字符串，并与用户请求中包含的认证字符串进行比对。如果认证字符串相同，系统认为用户拥有指定的操作权限，并执行相关操作；如果认证字符串不同，系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见 鉴权认证。
请求参数
Headers 参数
除公共头域外，无其它特殊头域
URL 参数
version
string
API版本号。
必选
endpoint
string
具体参考：https://cloud.baidu.com/doc/VDB/s/mls48re93
必选
Query 参数
Body 参数
请求结构
GET /v{version}/vdb/instance/list HTTP/1.1
HOST: vdb.bj.baidubce.com
Authorization: authorization string示例代码
请求示例
curl --location 'https://vdb.bj.baidubce.com/v1/vdb/instance/list' \
--header 'Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de' \
--header 'Content-Type: application/json'返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
instances
array
实例列表
可选
显示子属性
隐藏子属性
items
object {20}
显示子属性
隐藏子属性
ip
string
内网IP
可选
eip
string
弹性IP
可选
port
string
服务端口
可选
vpcId
string
VPC ID
可选
domain
string
域名
可选
status
string
状态 预创建"precreate" 创建中 "creating" 启动中 "staring" 运行中 "running" 暂停中 "pausing" 已暂停 "paused" 删除中 "deleting" 已删除 "deleted" 创建失败 "createfailed"
可选
vpcCidr
string
VPC IP地址段
可选
vpcName
string
VPC 名称
可选
nodeSpec
string
节点类型
可选
createTime
string
创建时间
可选
instanceId
string
实例ID
可选
productType
string
付费类型 postpay: 后付费 prepay：预付费
可选
instanceName
string
实例名称
可选
instanceType
string
实例类型，目前只支持集群版 cluster
可选
availabilityZone
string
可用区
可选
instanceExpireTime
stringnull
实例到期时间
可选
usedMemCapacityInGB
number
已用内存容量
可选
totalMemCapacityInGB
number
内存总容量
可选
usedDiskCapacityInGB
number
已用磁盘容量
可选
totalDiskCapacityInGB
number
磁盘总容量
可选
响应示例
{
"instances":[
{
"instanceType": "cluster",
"instanceId": "vdb-bdtest-htcPPBXBVsGH",
"instanceName": "vdb",
"ip": "192.168.1.148",
"port": 80,
"status": "running",
"createTime": "2024-01-18T03:56:43Z",
"domain": "vdb.SaGtELubxLvp.bdtest.vdb.bd.baidubce.com",
"vpcId": "vpc-3qmj7bu7a2yw",
"availabilityZone": "cn-bd-c",
"totalDiskCapacityInGB": 0.0,
"usedDiskCapacityInGB": 0.0,
"totalMemCapacityInGB": 0.0,
"usedMemCapacityInGB": 0.0,
"nodeSpec": "vdb.dc.large",
"eip": "",
"productType": "postpay",
"instanceExpireTime": null,
"vpcName": "非Agent重构测试",
"vpcCidr": "192.168.0.0/16"
}
]
}