文档首页 > > API参考> 实例管理类接口> 查询指定实例

查询指定实例

分享
更新时间: 2019/11/28 GMT+08:00

功能介绍

查询指定实例的详细信息。

URI

GET /v1.0/{project_id}/instances/{instance_id}

参数说明见表1

表1 参数说明

参数

类型

必选

说明

project_id

String

项目ID。

instance_id

String

实例ID。

请求消息

请求参数

无。

请求示例

无。

响应消息

响应参数

参数说明见表2

表2 参数说明

参数

类型

说明

name

String

实例名称。

engine

String

消息引擎。

engine_version

String

消息引擎版本。

specification

String

实例规格。

  • RabbitMQ实例单机返回vm规格。
  • RabbitMQ实例集群返回vm规格和节点数。
  • Kafka实例返回基准带宽值。

storage_space

Integer

消息存储空间,单位:GB。

partition_num

Integer

仅Kafka实例才有该参数。

Kafka实例的总分区数。

used_storage_space

Integer

已使用的消息存储空间,单位:GB。

connect_address

String

实例连接IP地址。

port

Integer

实例连接端口。

status

String

实例的状态。详细状态说明见实例状态说明

description

String

实例描述。

instance_id

String

实例ID。

resource_spec_code

String

资源规格标识。

  • dms.instance.kafka.cluster.c3.mini:Kafka实例的基准带宽为100MB。
  • dms.instance.kafka.cluster.c3.small.2:Kafka实例的基准带宽为300MB。
  • dms.instance.kafka.cluster.c3.middle.2:Kafka实例的基准带宽为600MB。
  • dms.instance.kafka.cluster.c3.high.2:Kafka实例的基准带宽为1200MB。
  • dms.instance.rabbitmq.single.c3.2u4g:RabbitMQ单机,vm规格2u4g
  • dms.instance.rabbitmq.single.c3.4u8g:RabbitMQ单机,vm规格4u8g
  • dms.instance.rabbitmq.single.c3.8u16g:RabbitMQ单机,vm规格8u16g
  • dms.instance.rabbitmq.single.c3.16u32g:RabbitMQ单机,vm规格16u32g
  • dms.instance.rabbitmq.cluster.c3.4u8g.3:RabbitMQ集群,vm规格4u8g,3个节点
  • dms.instance.rabbitmq.cluster.c3.4u8g.5:RabbitMQ集群,vm规格4u8g,5个节点
  • dms.instance.rabbitmq.cluster.c3.4u8g.7:RabbitMQ集群,vm规格4u8g,7个节点
  • dms.instance.rabbitmq.cluster.c3.8u16g.3:RabbitMQ集群,vm规格8u16g,3个节点
  • dms.instance.rabbitmq.cluster.c3.8u16g.5:RabbitMQ集群,vm规格8u16g,5个节点
  • dms.instance.rabbitmq.cluster.c3.8u16g.7:RabbitMQ集群,vm规格8u16g,7个节点
  • dms.instance.rabbitmq.cluster.c3.16u32g.3:RabbitMQ集群,vm规格16u32g,3个节点
  • dms.instance.rabbitmq.cluster.c3.16u32g.5:RabbitMQ集群,vm规格16u32g,5个节点
  • dms.instance.rabbitmq.cluster.c3.16u32g.7:RabbitMQ集群,vm规格16u32g,7个节点

type

String

实例类型。

  • 单机:single
  • 集群:cluster

Kafka实例类型,当前只支持集群类型。

charging_mode

Integer

付费模式,1表示按需计费,0表示包年/包月计费。

vpc_id

String

VPC ID。

vpc_name

String

VPC的名称。

created_at

String

完成创建时间。格式为时间戳,指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。

error_code

String

实例创建失败或状态异常时的错误码,错误码说明见表3

product_id

String

产品标识。

security_group_id

String

安全组ID。

security_group_name

String

租户安全组名称。

subnet_id

String

子网ID。

subnet_name

String

子网名称。

subnet_cidr

String

子网网段。

available_zones

Array

实例节点所在的可用区,返回“可用区ID”。

user_id

String

用户id。

user_name

String

用户名。

access_user

String

实例的用户名。

order_id

String

订单ID。

total_storage_space

Integer

总共消息存储空间,单位:GB。

storage_resource_id

String

存储资源ID。

storage_spec_code

String

IO规格。

retention_policy

String

消息老化策略。

ipv6_enable

Boolean

是否开启ipv6。

ipv6_connect_addresses

String

ipv6的连接地址。

connector_enable

Boolean

是否开启转储。

connector_id

String

转储任务ID。

rest_enable

Boolean

是否开启Kafka rest功能。

rest_connect_address

String

Kafka rest地址。

kafka_public_status

String

Kafka公网开启状态。

  • true:表示开启状态;
  • false和closed:表示关闭状态;
  • frozen:表示冻结状态

public_boundwidth

Integer

公网带宽。

message_query_inst_enable

Boolean

是否开启消息查询功能。

vpc_client_plain

Boolean

是否开启VPC明文访问。

trace_enable

Boolean

是否开启消息轨迹功能。

enable_auto_topic

Boolean

是否开启Kafka实例自动创建Topic开关。

  • true:开启
  • false:未开启

maintain_begin

String

维护时间窗开始时间,格式为HH:mm。

maintain_end

String

维护时间窗结束时间,格式为HH:mm。

enable_publicip

Boolean

RabbitMQ实例是否开启公网访问功能。

  • true:开启
  • false:未开启

publicip_address

String

RabbitMQ实例绑定的弹性IP地址。

如果未开启公网访问功能,该字段值为null。

publicip_id

String

RabbitMQ实例绑定的弹性IP地址的ID。

如果未开启公网访问功能,该字段值为null。

management_connect_address

String

RabbitMQ实例的管理地址。

Kafka实例的KafkaManager连接地址。

ssl_enable

Boolean

是否开启安全认证。

  • true:开启
  • false:未开启

enterprise_project_id

String

企业项目ID。

is_logical_volume

Boolean

实例扩容时用于区分老实例与新实例。

  • true:新创建的实例,允许磁盘动态扩容不需要重启。
  • false:老实例。

extend_times

String

实例扩容磁盘次数,如果超过20次则无法扩容磁盘。

service_type

String

服务类型。

storage_type

String

存储类型。

表3 错误码说明

错误码

说明

public.00.0001

内部服务错误。

public.00.0002

内部服务错误。

public.00.0003

内部服务错误。

public.00.0004

VPC创建失败。

public.00.0005

安全组创建失败。

public.00.0006

子网创建失败。

public.00.0007

子网状态异常。

public.00.0008

创建ECS失败。

public.00.0009

创建ECS失败。

public.00.0010

创建ECS失败。

public.00.0011

ECS绑定网卡失败。

public.00.0013

ECS启动失败。

public.00.0014

ECS启动失败。

public.00.0015

ECS停止失败。

public.00.0018

创建ECS失败,ECS资源配额不足。

public.00.0024

实例部署异常。

public.00.0025

实例部分节点故障。

public.00.0042

无法连接实例。

响应示例

Kafka实例:

{
    "name": "kafka-1970157411",
    "engine": "kafka",
    "port": 9092,
    "status": "RUNNING",
    "type": "cluster",
    "specification": "1200MB",
    "engine_version": "1.1.0",
    "connect_address": "192.168.0.177,192.168.0.201,192.168.0.155",
    "instance_id": "f54bb332-9543-4eaa-9d0d-8d5a351b792a",
    "resource_spec_code": "dms.instance.kafka.cluster.c3.high",
    "charging_mode": 1,
    "vpc_id": "3f993404-bca2-45de-89a0-9c6ed67b4c9f",
    "vpc_name": "AZ1",
    "created_at": "1533023309334",
    "product_id": "00300-30306-0--0",
    "security_group_id": "2c6a52c4-0f5c-4509-afac-f40869539385",
    "security_group_name": "sg-b083",
    "subnet_id": "9b19c05a-d4c5-4c19-81f4-c428999182a2",
    "subnet_name": "subnet-d238",
    "subnet_cidr": "192.168.0.0/24",
    "available_zones": ["kvmxen.dc1"],
    "user_id": "d7e974c2f47a4d3f836251d47b1fe495",
    "user_name": "zhou_jianyou",
    "maintain_begin": "22:00",
    "maintain_end": "02:00",
    "storage_space": 4800,
    "used_storage_space": 429,
    "partition_num": "1800",
    "enable_publicip": false,
    "ssl_enable": false,
    "management_connect_address": "http://192.168.0.177:9999",
    "enterprise_project_id": "0",
    "is_logical_volume": true,
    "extend_times": 10
}

RabbitMQ实例:

{ 
    "name" : "dms-a11e", 
    "engine" : "rabbitmq", 
    "engine_version" : "3.7.0",
    "specification" : "2vCPUs 4GB", 
    "storage_space" : 100,
    "used_storage_space" : 50,
    "connect_address" : "192.168.3.100", 
    "port" : 5672, 
    "status" : "RUNNING", 
    "description" : "Create a instance", 
    "instance_id" : "68d5745e-6af2-40e4-945d-fe449be00148", 
    "resource_spec_code" : "dms.instance.rabbitmq.single.c3.2u4g", 
    "type" : "single", 
    "charging_mode" : 1, 
    "vpc_id" : "27d99e17-42f2-4751-818f-5c8c6c03ff15", 
    "vpc_name" : "vpc_4944a40e-ac57-4f08-9d38-9786e2759458_192", 
    "created_at" : "1526367063931", 
    "error_code" : null, 
    "product_id" : "00300-30109-0--0", 
    "security_group_id" : "60ea2db8-1a51-4ab6-9e11-65b418c24583", 
    "security_group_name" : "sg_6379_4944a40e-ac57-4f08-9d38-9786e2759458", 
    "subnet_id" : "ec2f34b9-20eb-4872-85bd-bea9fc943128", 
    "subnet_name" : "subnet_az_7f336767-10ec-48a5-9ae8-9cacde119318", 
    "subnet_cidr" : "192.168.0.0/24", 
    "available_zones" : ["1d7b939b382c4c3bb3481a8ca10da785"],
    "user_id": "6d0977e4c9b74ae7b5a083a8d0d8fafa", 
    "user_name": "aabb02", 
    "access_user": "user",
    "order_id": "XXXXXXXXX", 
    "maintain_begin" : "22:00", 
    "maintain_end" : "02:00", 
    "enable_publicip" : "true",
    "publicip_id": "b7940732-11ef-459b-acab-cab0d26c74a3", 
    "publicip_address": "192.168.10.5",
    "ssl_enable": false,
    "management_connect_address": "http://192.168.0.177:9999"
 }

状态码

操作成功的状态码如表4所示,其他响应见状态码

表4 状态码

状态码

描述

200

查询指定实例成功。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区