查询DDM实例列表
功能介绍
查询DDM实例列表。
接口约束
无
URI
GET /v1/{project_id}/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一region下的project ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
是 |
Integer |
分页参数:起始值 [大于等于0] 。 最小值:0 |
limit |
是 |
Integer |
分页参数:每页多少条 [大于0且小于等于128]。 最小值:1 最大值:128 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
instances |
Array of ShowDDMInstanceResponse objects |
DDM实例的信息。 |
instance_num |
Integer |
租户下的DDM实例个数。 |
page_no |
Integer |
当前页码。 |
page_size |
Integer |
当前页码的数据条数。 |
total_record |
Integer |
总条数。 |
total_page |
Integer |
总页数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
DDM实例ID。 |
status |
String |
DDM实例状态。 |
name |
String |
创建的实例名称。 |
created |
String |
创建时间。 |
updated |
String |
更新时间,格式与“created”完全相同。 |
available_zone |
String |
可用区名称。 |
vpc_id |
String |
虚拟私有云的ID。 |
subnet_id |
String |
子网ID。 |
security_group_id |
String |
安全组ID。 |
node_count |
Integer |
节点数量。 |
access_ip |
String |
DDM实例访问地址。 |
access_port |
String |
DDM实例访问端口。 |
core_count |
String |
CPU个数。 |
ram_capacity |
String |
内存大小,单位为G。 |
error_msg |
String |
响应信息,若无异常信息则不返回该参数。 |
node_status |
String |
节点状态。 |
enterprise_project_id |
String |
企业项目ID。 |
project_id |
String |
租户在某一region下的project ID。 |
engine_version |
String |
引擎版本号(Core实例版本号)。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
errCode |
String |
业务错误码 |
externalMessage |
String |
错误信息 |
请求示例
GET https://{endpoint}/v1/{project_id}/instances?offset={offset}&limit={limit}
响应示例
状态码: 400
bad request
{ "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" }
状态码
请参见状态码。
错误码
请参见错误码。