查询DDM实例详情
功能介绍
查询指定DDM实例的详细信息。
接口约束
无
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/instances/{instance_id}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 租户在某一region下的project ID。 获取方法请参见获取项目ID。 |
instance_id | 是 | String | DDM实例ID。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 |
响应参数
状态码： 200
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | DDM实例ID。 |
status | String | DDM实例状态。具体取值请参见相关状态说明。 |
name | String | DDM实例名称。 |
created | String | DDM实例创建时间，格式为“yyyy-mm-dd Thh:mm:ssZ”。 |
updated | String | DDM实例最后更新时间。 |
available_zone | String | DDM实例可用区名称。 |
vpc_id | String | 虚拟私有云的ID。 |
subnet_id | String | 子网ID。 |
security_group_id | String | 安全组ID。 |
node_count | Integer | 节点数量。 |
access_ip | String | DDM实例访问地址。 |
access_port | String | DDM实例访问端口。 |
node_status | String | 节点状态。 |
core_count | String | CPU个数。 |
ram_capacity | String | 内存大小，单位为GB。 |
error_msg | String | 响应信息，若无异常信息则不返回该参数。 |
project_id | String | 项目ID。 |
order_id | String | 订单ID。包周期实例的订单ID，按需实例为空。 |
enterprise_project_id | String | 企业项目ID。 |
engine_version | String | 引擎版本号。 |
nodes | Array of GetDetailfNodesInfo objects | 节点信息。 |
admin_user_name | String | 管理员账号用户名。 |
enable_ssl | Boolean | 实例开启SSL标志。
|
flavor_ref | String | 规格码。 |
参数 | 参数类型 | 描述 |
|---|---|---|
status | String | DDM实例节点状态。 |
port | String | DDM实例节点Port。 |
ip | String | DDM实例节点IP。如果开启负载均衡，则是节点所在组的ELB IP |
group_id | String | 节点所在组ID |
node_id | String | 节点ID |
状态码： 400
参数 | 参数类型 | 描述 |
|---|---|---|
errCode | String | 业务错误码。 |
externalMessage | String | 错误信息。 |
状态码： 500
参数 | 参数类型 | 描述 |
|---|---|---|
errCode | String | 业务错误码。 |
externalMessage | String | 错误信息。 |
请求示例
查询实例详情。
GET https://{endpoint}/v1/{project_id}/instances/{instance_id} 响应示例
状态码： 200
OK
{
"nodes" : [ {
"status" : "RUNNING",
"port" : 5066,
"ip" : "192.168.0.160",
"group_id": "b4153b807b1a4f83870bf868fcc4f4eagr09",
"node_id": "4a2b97b7f5e3462c9c78aae93b46ed83no09"
} ],
"id" : "1f5c9fd6cd984056ba89c8c87cc03278in09",
"status" : "RUNNING",
"name" : "ddm2-test",
"created" : "2021-11-09T03:30:01+0000",
"updated" : "2021-12-15T09:12:58+0000",
"available_zone" : "az1",
"vpc_id" : "cfaa4024-0603-4aba-81d4-2203b4ad26fb",
"subnet_id" : "48f270ef-af70-4ad9-bb1c-c28dd5b37f93",
"security_group_id" : "bc28ef93-0083-4652-bce6-381e14284db6",
"node_count" : 1,
"access_ip" : "192.168.0.160",
"access_port" : "5066",
"core_count" : "2",
"ram_capacity" : "8",
"node_status" : "RUNNING",
"enterprise_project_id" : "0",
"project_id" : "070c071d8e80d58c2f42c0121b10cf9f",
"engine_version" : "3.0.6",
"admin_user_name" : "root",
"enable_ssl" : false,
"flavor_ref" : "ddm.c6.large.2"
} 状态码： 400
bad request
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
} 状态码： 500
server error
{
"externalMessage" : "Server failure.",
"errCode" : "DBS.200412"
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | bad request |
500 | server error |
错误码
请参见错误码。
