Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying All Instances

Updated on 2022-08-12 GMT+08:00

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.

Table 1 Parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Project ID.

engine

String

No

Message engine. Value: kafka

name

String

No

Instance name.

id

String

No

Instance ID.

status

String

No

Instance status. For details, see Instance Status.

includeFailure

String

No

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

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

Enterprise project ID.

Example

GET /v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&exactMatchName=false  

Request

Request parameters

None.

Example request

None.

Response

Response parameters

Table 2 describes the parameters.

Table 2 Response parameters

Parameter

Type

Description

instances

Array

Instance details.

instance_num

Integer

Number of instances.

Table 3 instance parameter description

Parameter

Type

Description

name

String

Instance name.

engine

String

Message engine.

engine_version

String

Engine version.

specification

String

Instance specification.

storage_space

Integer

Message storage space. Unit: GB

partition_num

String

Maximum number of topics in a Kafka instance.

used_storage_space

Integer

Used message storage space. Unit: GB

connect_address

String

Instance IP address.

port

Integer

Instance port.

status

String

Instance status. For details, see Instance Status.

instance_id

String

Instance ID.

resource_spec_code

String

Resource specifications identifier.

  • dms.instance.kafka.cluster.c3.mini: Kafka instance, 100 MB/s reference bandwidth
  • dms.instance.kafka.cluster.c3.small.2: Kafka instance, 300 MB/s reference bandwidth
  • dms.instance.kafka.cluster.c3.middle.2: Kafka instance, 600 MB reference bandwidth
  • dms.instance.kafka.cluster.c3.high.2: Kafka instance, 1200 MB reference bandwidth

charging_mode

Integer

Billing mode.

vpc_id

String

VPC ID.

vpc_name

String

VPC name.

created_at

String

Time when the 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

User ID.

user_name

String

Username.

maintain_begin

String

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

management_connect_address

String

Connection address of Kafka Manager of the Kafka instance.

ssl_enable

Boolean

Whether security authentication is enabled.

  • true: enable
  • false: disable

enterprise_project_id

String

Enterprise project ID.

is_logical_volume

Boolean

Distinguishes old instances from new instances during instance capacity expansion.

  • true: New instance, which allows dynamic disk capacity expansion without restarting the instance.
  • false: Old instance.

extend_times

Integer

Number of disk expansion times. If it exceeds 20, the disk cannot be expanded.

enable_auto_topic

Boolean

Whether automatic topic creation is enabled.

  • true: enabled
  • false: disabled

type

String

Instance type. Value: cluster.

product_id

String

Product ID.

security_group_id

String

Security group ID.

security_group_name

String

Security group name.

subnet_id

String

Subnet ID.

available_zones

Array

ID of the AZ to which the instance node belongs. The AZ ID is returned.

total_storage_space

Integer

Message storage space. Unit: GB

storage_resource_id

String

Storage resource ID.

storage_spec_code

String

I/O specification.

service_type

String

Service type.

storage_type

String

Storage type.

retention_policy

String

Message retention policy.

kafka_manager_user

String

Username for logging in to Kafka Manager.

enable_log_collection

Boolean

Whether log collection is enabled.

cross_vpc_info

String

Cross-VPC access information.

ipv6_enable

Boolean

Whether IPv6 is enabled.

ipv6_connect_addresses

Array of strings

IPv6 connection address.

rest_enable

Boolean

Whether the Kafka REST function is enabled.

rest_connect_address

String

Kafka REST address.

message_query_inst_enable

Boolean

Whether message query is enabled.

vpc_client_plain

Boolean

Whether intra-VPC plaintext access is enabled.

support_features

String

List of features supported by the Kafka instance.

trace_enable

Boolean

Whether message tracing is enabled.

pod_connect_address

String

Connection address on the tenant side.

disk_encrypted

Boolean

Whether disk encryption is enabled.

kafka_private_connect_address

String

Private connection address of a Kafka instance.

ces_version

String

Cloud Eye version.

tags

Array<Object>

List of tags.

Table 4 tags

Parameter

Type

Description

key

String

Tag key.

value

String

Tag value.

Example response

{
    "instances": [
        {
            "name": "kafka-l00230526",
            "engine": "kafka",
            "port": 9092,
            "status": "RUNNING",
            "type": "cluster",
            "specification": "100MB",
            "engine_version": "XXX",
            "connect_address": "192.168.1.116,192.168.1.152,192.168.1.78",
            "instance_id": "ef84dd5f-3ece-4336-8c99-987defd62e3a",
            "resource_spec_code": "dms.instance.kafka.cluster.c3.mini",
            "charging_mode": 1,
            "vpc_id": "2477879f-aebf-496f-a08a-67812885ce9b",
            "vpc_name": "vpc-y00502467",
            "created_at": "1568797295209",
            "product_id": "00300-30308-0--0",
            "security_group_id": "008a08e2-10cc-4d9b-90ab-3f3b8f6c3333",
            "security_group_name": "z00417080-cce-node-na7j",
            "subnet_id": "5ca08fb7-7522-4d95-9fa5-ff6b3592a29d",
            "available_zones": [
                "ae04cf9d61544df3806a3feeb401b204"
            ],
            "user_id": "2b4af4428ec840dfa1f0f1a32e965567",
            "user_name": "laiyh",
            "kafka_manager_user": "root",
            "maintain_begin": "22:00",
            "maintain_end": "02:00",
            "storage_space": 492,
            "total_storage_space": 600,
            "used_storage_space": 25,
            "partition_num": "300",
            "ssl_enable": false,
            "management_connect_address": "https://192.168.1.116:9999",
            "storage_resource_id": "81982562-ce8b-490a-95fa-2b225c292271",
            "storage_spec_code": "dms.physical.storage.ultra",
            "service_type": "advanced",
            "storage_type": "hec",
            "enterprise_project_id": "0",
            "is_logical_volume": true,
            "extend_times": 0,
            "retention_policy": "produce_reject",
            "ipv6_enable": false,
            "ipv6_connect_addresses": [],
            "rest_enable": false,
            "rest_connect_address": "",
            "message_query_inst_enable": true,
            "vpc_client_plain": false,
            "support_features": "feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,feature.physerver.kafka.user.manager",
            "trace_enable": false,
            "agent_enable": false,
            "pod_connect_address": "100.113.16.105:9100,100.113.5.197:9100,100.113.15.231:9100",
            "disk_encrypted": false,
            "enable_auto_topic": true
        }
    ],
    "instance_num": 1
}

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Status Code.

Table 5 Status code

Status Code

Description

200

All instances are queried successfully.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback