更新时间:2022-12-05 GMT+08:00

查询MQS实例详情

功能介绍

查询指定MQS实例详情。

URI

GET /v2/{project_id}/mqs/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户的项目ID。

instance_id

String

实例ID。

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

name

String

实例名称。

description

String

描述信息。

engine

String

引擎。

engine_version

String

版本。

specification

String

实例规格。

storage_space

Integer

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

partition_num

Integer

Kafka实例的最大topic数。

used_storage_space

Integer

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

connect_address

String

实例连接IP地址。

port

Integer

实例连接端口。

status

String

实例的状态。

  • CREATING: 申请实例后,在实例状态进入运行中之前的状态。
  • RUNNING: 实例正常运行状态。在这个状态的实例可以运行您的业务。

instance_id

String

实例ID。

resource_spec_code

String

资源规格标识。

  • dms.instance.kafka.cluster.c3.mini:Kafka实例的基准带宽为100MByte/秒。
  • dms.instance.kafka.cluster.c3.small.2:Kafka实例的基准带宽为300MByte/秒。
  • dms.instance.kafka.cluster.c3.middle.2:Kafka实例的基准带宽为600MByte/秒。
  • dms.instance.kafka.cluster.c3.high.2:Kafka实例的基准带宽为1200MByte/秒。

charging_mode

Integer

付费模式。

vpc_id

String

VPC ID。

vpc_name

String

VPC的名称。

created_at

String

完成创建时间。

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

user_id

String

用户ID。

user_name

String

用户名。

order_id

String

订单ID。

maintain_begin

String

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

maintain_end

String

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

enable_publicip

Boolean

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

  • true:开启
  • false:未开启

management_connect_address

String

Kafka实例的KafkaManager连接地址。

ssl_enable

Boolean

是否开启安全认证。

  • true:开启
  • false:未开启

enterprise_project_id

String

企业项目ID。

is_logical_volume

Boolean

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

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

extend_times

Integer

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

enable_auto_topic

Boolean

是否打开kafka自动创建topic功能。

  • true:开启
  • false:关闭

type

String

实例类型:集群,cluster。

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 of strings

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

total_storage_space

Integer

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

public_connect_address

String

实例公网连接IP地址。当实例开启了公网访问,实例才包含该参数。

storage_resource_id

String

存储资源ID。

storage_spec_code

String

IO规格。

service_type

String

服务类型。

storage_type

String

存储类型。

retention_policy

String

消息老化策略。

kafka_public_status

String

Kafka公网开启状态。

public_bandwidth

Integer

公网带宽。

kafka_manager_user

String

登录Kafka Manager的用户名。

enable_log_collection

Boolean

是否开启消息收集功能。

cross_vpc_info

String

跨VPC访问信息。

ipv6_enable

Boolean

是否开启ipv6。

ipv6_connect_addresses

Array of strings

IPv6的连接地址。

connector_enable

Boolean

是否开启转储。

connector_id

String

转储任务ID。

mqs_connector_enable

Boolean

是否开启MQS转储。

mqs_connector_address

String

MQS转储地址。

plugin_enable

Boolean

是否开启插件功能。

rest_enable

Boolean

是否开启Kafka rest功能。

rest_connect_address

String

Kafka rest连接地址。

message_query_inst_enable

Boolean

是否开启消息查询功能。

vpc_client_plain

Boolean

是否开启VPC明文访问。

support_features

String

Kafka实例支持的特性功能。

trace_enable

Boolean

是否开启消息轨迹功能。

pod_connect_address

String

租户侧连接地址。

disk_encrypted

Boolean

是否开启磁盘加密。

kafka_private_connect_address

String

Kafka实例私有连接地址。

ces_version

String

云监控版本。

node_num

Integer

节点数量。

publicip_address

String

公网连接地址。

listeners

Object

监听信息。

public_access_enabled

String

是否开启公网访问。用于区分何时开启的公网访问。

public_boundwidth

Integer

公网访问带宽。

connect_dn

String

实例连接地址。

agent_enable

Boolean

是否开启代理。

请求示例

GET https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}

响应示例

状态码: 200

OK

{
  "name" : "romamqs_640bb069-151e-4d5e-bd1b-xxxxxxxxxxxx",
  "engine" : "kafka",
  "port" : 9093,
  "status" : "RUNNING",
  "description" : "roma-mqs",
  "type" : "cluster",
  "specification" : "100MB",
  "engine_version" : "1.1.0",
  "connect_address" : "192.168.0.57,192.168.0.227,192.168.0.234",
  "connect_dn" : "",
  "instance_id" : "640bb069-151e-4d5e-bd1b-xxxxxxxxxxxx",
  "resource_spec_code" : "dms.instance.kafka.cluster.c3.mini",
  "charging_mode" : 1,
  "vpc_id" : "5810f4bb-b202-45cd-a5d1-xxxxxxxxxxxx",
  "vpc_name" : "vpc-4aeb",
  "created_at" : "1601016527494",
  "product_id" : "00300-30308-0--0",
  "security_group_id" : "20d120f2-70ba-4c8d-a6a4-xxxxxxxxxxxx",
  "security_group_name" : "sg-5ab2",
  "subnet_id" : "08c8e51c-7013-43ee-bb0a-xxxxxxxxxxxx",
  "subnet_name" : "subnet-4afa",
  "subnet_cidr" : "192.168.0.0/24",
  "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
  "user_id" : "4d1a542e7bcf400cb9c8efada01406d8",
  "user_name" : "paas_test",
  "access_user" : "mqs-gen-user-1601016526411",
  "maintain_begin" : "22:00:00",
  "maintain_end" : "02:00:00",
  "enable_log_collection" : false,
  "storage_space" : 490,
  "total_storage_space" : 600,
  "used_storage_space" : 25,
  "partition_num" : "300",
  "enable_publicip" : true,
  "publicip_address" : "10.10.10.170",
  "ssl_enable" : true,
  "cross_vpc_info" : "{\"192.168.0.227\":{\"advertised_ip\":\"192.168.0.227\",\"port\":9011,\"port_id\":\"6ba24c0a-c3ba-4fb8-9adb-84b7a346a623\"},\"192.168.0.57\":{\"advertised_ip\":\"192.168.0.57\",\"port\":9011,\"port_id\":\"4d34a44d-d968-4dcb-89a9-e38e62626df6\"},\"192.168.0.234\":{\"advertised_ip\":\"192.168.0.234\",\"port\":9011,\"port_id\":\"9eac2e81-323c-4d2d-acce-7f84f2d3bd9b\"}}",
  "storage_resource_id" : "234705d3-8f33-451a-92aa-xxxxxxxxxxxx",
  "storage_spec_code" : "dms.physical.storage.normal",
  "service_type" : "advanced",
  "storage_type" : "hec",
  "is_logical_volume" : true,
  "extend_times" : 0,
  "retention_policy" : "produce_reject",
  "ipv6_enable" : false,
  "ipv6_connect_addresses" : [ ],
  "connector_enable" : false,
  "mqs_connector_enable" : true,
  "mqs_connector_address" : "192.168.0.10:9776;192.168.0.17:9776",
  "connector_id" : "",
  "rest_enable" : true,
  "rest_connect_address" : "https://10.10.10.170:9292",
  "kafka_public_status" : "false",
  "public_bandwidth" : 0,
  "public_boundwidth" : 0,
  "message_query_inst_enable" : true,
  "vpc_client_plain" : false,
  "support_features" : "kafka.crossvpc.domain.enable,feature.physerver.kafka.topic.accesspolicy,rabbitmq.plugin.management,roma_app_enable,auto_topic_switch,feature.physerver.kafka.user.manager,route,kafka.new.pod.port,feature.physerver.kafka.topic.modify,message_trace_enable,features.pod.token.access,roma.user.manage.no.support,feature.physerver.kafka.pulbic.dynamic,features.log.collection",
  "trace_enable" : false,
  "agent_enable" : false,
  "listeners" : [ {
    "name" : "mqs-kafka-1",
    "port" : 9096,
    "backend" : {
      "ip" : [ "192.168.0.227" ],
      "port" : 9096,
      "health_check" : {
        "protocol" : "TCP_CHECK",
        "port" : 9093,
        "param" : null
      }
    }
  }, {
    "name" : "mqs-kafka-2",
    "port" : 9097,
    "backend" : {
      "ip" : [ "192.168.0.234" ],
      "port" : 9097,
      "health_check" : {
        "protocol" : "TCP_CHECK",
        "port" : 9093,
        "param" : null
      }
    }
  }, {
    "name" : "mqs-connector-0",
    "port" : 20911,
    "backend" : {
      "ip" : [ "192.168.0.10" ],
      "port" : 20911,
      "health_check" : {
        "protocol" : "TCP_CHECK",
        "port" : 20911,
        "param" : null
      }
    }
  }, {
    "name" : "mqs-connector-1",
    "port" : 20912,
    "backend" : {
      "ip" : [ "192.168.0.17" ],
      "port" : 20912,
      "health_check" : {
        "protocol" : "TCP_CHECK",
        "port" : 20912,
        "param" : null
      }
    }
  }, {
    "name" : "mqs-kafka-0",
    "port" : 9095,
    "backend" : {
      "ip" : [ "192.168.0.57" ],
      "port" : 9095,
      "health_check" : {
        "protocol" : "TCP_CHECK",
        "port" : 9093,
        "param" : null
      }
    }
  }, {
    "name" : "mqs-namesrv",
    "port" : 9776,
    "backend" : {
      "ip" : [ "192.168.0.10", "192.168.0.17" ],
      "port" : 9776,
      "health_check" : {
        "protocol" : "TCP_CHECK",
        "port" : 9776,
        "param" : null
      }
    }
  }, {
    "name" : "mqs-rest",
    "port" : 9292,
    "backend" : {
      "ip" : [ "192.168.0.38", "192.168.0.230" ],
      "port" : 9292,
      "health_check" : {
        "protocol" : "TCP_CHECK",
        "port" : 9292,
        "param" : null
      }
    }
  } ],
  "pod_connect_address" : "10.10.10.122:9080,10.10.10.96:9080,10.10.10.66:9080",
  "disk_encrypted" : false,
  "kafka_private_connect_address" : "192.168.0.227:9093,192.168.0.234:9093,192.168.0.57:9093",
  "enable_auto_topic" : false,
  "ces_version" : "linux,v1,v2",
  "plugin_enable" : false,
  "public_access_enabled" : "false",
  "node_num" : 3
}

状态码

状态码

描述

200

OK

错误码

请参见错误码