实例列表
更新时间：2024-06-27
VDB实例列表
接口描述
- 只能查看属于自己账号当前地域下有权限的实例列表
- 本接口为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和同样的认证机制生成认证字符串，并与用户请求中包含的认证字符串进行比对。如果认证字符串相同，系统认为用户拥有指定的操作权限，并执行相关操作；如果认证字符串不同，系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见 鉴权认证。
注意事项
请求结构
GET /v{version}/vdb/instance/list HTTP/1.1
HOST: vdb.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instances | List< Instance> | 实例列表 |
Instance结构说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceType | String | 实例类型，目前只支持集群版 cluster |
| instanceId | String | 实例ID |
| instanceName | String | 实例名称 |
| ip | String | 内网IP |
| port | String | 服务端口 |
| status | String | 状态 预创建"precreate" 创建中 "creating" 启动中 "staring" 运行中 "running" 暂停中 "pausing" 已暂停 "paused" 删除中 "deleting" 已删除 "deleted" 创建失败 "createfailed" |
| createTime | String | 创建时间 |
| domain | String | 域名 |
| vpcId | String | VPC ID |
| vpcName | String | VPC 名称 |
| vpcCidr | String | VPC IP地址段 |
| availabilityZone | String | 可用区 |
| totalDiskCapacityInGB | Float | 磁盘总容量 |
| usedDiskCapacityInGB | Float | 已用磁盘容量 |
| totalMemCapacityInGB | Float | 内存总容量 |
| usedMemCapacityInGB | Float | 已用内存容量 |
| nodeSpec | String | 节点类型 |
| eip | String | 弹性IP |
| productType | String | 付费类型 postpay: 后付费 prepay：预付费 |
| instanceExpireTime | String | 实例到期时间 |
请求示例
GET /v1/vdb/instance/list HTTP/1.1
HOST: vdb.bj.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de 响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
"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"
}
]
}