Querying All Instances
This API is out-of-date and may not be maintained in the future. Please use the API described in Listing All Instances.
Function
This API is used to query the instances of a tenant by set conditions.
URI
GET /v1.0/{project_id}/instances?engine={engine}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&exactMatchName={exactMatchName}&enterprise_project_id={enterprise_project_id}
Table 1 describes the parameters.
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
project_id |
String |
Yes |
Indicates the ID of a project. |
engine |
String |
No |
Indicates the message engine. Value: kafka |
name |
String |
No |
Indicates the instance name. |
id |
String |
No |
Indicates the instance ID. |
status |
String |
No |
Indicates the instance status. For details, see Instance Status. |
includeFailure |
String |
No |
Indicates whether to return the number of instances that fail to be created. If the value is true, the number of instances that failed to be created is returned. If the value is not true, the number is not returned. |
exactMatchName |
String |
No |
Indicates whether to search for the instance that precisely matches a specified instance name. The default value is false, indicating that a fuzzy search is performed based on a specified instance name. If the value is true, the instance that precisely matches a specified instance name is queried. |
enterprise_project_id |
String |
No |
Indicates the enterprise project ID. |
Request
Request parameters
None.
Example request
GET https://{dms_endpoint}/v1.0/{project_id}/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&exactMatchName=false
Response
Response parameters
Table 2 describes the parameters.
Parameter |
Type |
Description |
---|---|---|
instances |
Array |
Indicates instance details. |
instance_num |
Integer |
Indicates the number of instances. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Indicates the instance name. |
engine |
String |
Indicates the message engine. |
engine_version |
String |
Indicates the engine version. |
specification |
String |
Indicates the specifications of an instance. |
storage_space |
Integer |
Indicates the message storage space. Unit: GB |
partition_num |
String |
Indicates the maximum number of topics in a Kafka instance. |
used_storage_space |
Integer |
Indicates the used message storage space. Unit: GB |
connect_address |
String |
Indicates the IP address of an instance. |
port |
Integer |
Indicates the port number of an instance. |
status |
String |
Indicates the status of an instance. For details, see Instance Status. |
instance_id |
String |
Indicates the instance ID. |
resource_spec_code |
String |
Indicates the resource specifications identifier.
|
charging_mode |
Integer |
Billing mode. |
vpc_id |
String |
Indicates the ID of a VPC. |
vpc_name |
String |
Indicates the name of a VPC. |
created_at |
String |
Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time. |
user_id |
String |
Indicates the user ID. |
user_name |
String |
Indicates the username. |
maintain_begin |
String |
Indicates the time at which a maintenance time window starts. Format: HH:mm:ss |
maintain_end |
String |
Time at which the maintenance time window ends. Format: HH:mm:ss |
enable_publicip |
Boolean |
Indicates whether to enable public access for an instance.
|
ssl_enable |
Boolean |
Indicates whether to enable security authentication.
|
enterprise_project_id |
String |
Indicates the enterprise project ID. |
enable_auto_topic |
Boolean |
Indicates whether automatic topic creation is enabled.
|
type |
String |
Indicates the instance type. Value: cluster. |
product_id |
String |
Indicates the product ID. |
security_group_id |
String |
Indicates the security group ID. |
security_group_name |
String |
Indicates the security group name. |
subnet_id |
String |
Indicates the subnet ID. |
available_zones |
Array |
Indicates the AZ to which the instance node belongs. The AZ ID is returned. |
total_storage_space |
Integer |
Indicates the message storage space. Unit: GB |
public_connect_address |
String |
Indicates the instance IP address for public access. This parameter is displayed only when public access is enabled. |
storage_resource_id |
String |
Indicates the storage resource ID. |
storage_spec_code |
String |
Indicates the I/O specification. |
service_type |
String |
Indicates the service type. |
storage_type |
String |
Indicates the storage type. |
retention_policy |
String |
Indicates the message retention policy. |
kafka_public_status |
String |
Indicates whether Kafka public access is enabled. |
public_bandwidth |
Integer |
Indicates the public network bandwidth. |
enable_log_collection |
Boolean |
Indicates whether log collection is enabled. |
cross_vpc_info |
String |
Indicates cross-VPC access information. |
ipv6_enable |
Boolean |
Indicates whether IPv6 is enabled. |
ipv6_connect_addresses |
Array of strings |
Indicates the IPv6 connection address. |
rest_enable |
Boolean |
Indicates whether the Kafka REST function is enabled. |
rest_connect_address |
String |
Indicates the Kafka REST address. |
message_query_inst_enable |
Boolean |
Indicates whether message query is enabled. |
vpc_client_plain |
Boolean |
Indicates whether intra-VPC plaintext access is enabled. |
support_features |
String |
Indicates the list of features supported by the Kafka instance. |
trace_enable |
Boolean |
Indicates whether message tracing is enabled. |
pod_connect_address |
String |
Indicates the connection address on the tenant side. |
disk_encrypted |
Boolean |
Indicates whether disk encryption is enabled. |
kafka_private_connect_address |
String |
Indicates the private connection address of a Kafka instance. |
ces_version |
String |
Indicates the Cloud Eye version. |
Example response
{ "instances": [{ "name": "kafka-2101614746", "engine": "kafka", "port": 9092, "status": "RUNNING", "type": "cluster", "specification": "100MB", "engine_version": "2.3.0", "connect_address": "192.168.0.208,192.168.0.203,192.168.0.200", "instance_id": "b2fa82cc-3682-4e8c-bc20-e4a4d23ec142", "resource_spec_code": "dms.instance.kafka.cluster.c3.mini", "charging_mode": 1, "vpc_id": "1511c95c-540c-42b7-ae78-72fdb3502dc4", "vpc_name": "vpc-111", "created_at": "1586317449053", "product_id": "00300-30308-0--0", "security_group_id": "0b605722-22ce-4727-bde8-e5366aff941d", "security_group_name": "sg-Kafka", "subnet_id": "f8f80ddd-09f7-4f79-a702-3d5f74f215a3", "available_zones": ["xxx"], "user_id": "5f94abe9222e4d05a98986c348ee8afa", "user_name": "hby-zwx822581", "maintain_begin": "22:00:00", "maintain_end": "02:00:00", "storage_space": 492, "total_storage_space": 600, "used_storage_space": 25, "partition_num": "300", "enable_publicip": true, "ssl_enable": false, "public_connect_address": "10.185.69.162:9094,10.185.74.250:9094,10.185.69.63:9094", "storage_resource_id": "7a42b239-1891-44fe-9834-3b4712c49d21", "storage_spec_code": "dms.physical.storage.ultra", "service_type": "advanced", "storage_type": "hec", "retention_policy": "produce_reject", "kafka_public_status": "true", "public_bandwidth": 18 }], "instance_num": 1 }
Status Code
Table 4 describes the status code of successful operations. For details about other status codes, see Status Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot