Query instance IDs in all regions-ApsaraMQ for Kafka(Kafka)-阿里云帮助中心

Retrieves the IDs of all ApsaraMQ for Kafka instances under your Alibaba Cloud account, grouped by region.

Debugging

OpenAPI Explorer generates signature values and SDK sample code automatically. Use it to debug this API directly.

Authorization information

To call this API, your RAM user or RAM role must have the following permission. Add the Action value to your RAM policy.

Operation	Access level	Resource type	Condition key	Associated operation
alikafka:ListInstance	Read	Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Region ID. This is a reserved field.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
Code	integer	Response code. `200` indicates success.	200
Message	string	Response message.	operation success.
RequestId	string	Request ID. Use this value for troubleshooting.	ABA4A7FD-E10F-45C7-9774-A5236015\\\\
InstanceIds	object	Instance IDs grouped by region. Each key is a region ID and the value is an array of instance IDs in that region.	See the sample response below.
Success	boolean	Whether the request succeeded.	true

Sample response

JSON format

{
  "Code": 200,
  "Message": "operation success.",
  "InstanceIds": [
    {
      "cn-shenzhen": [
        "alikafka_post-cn-7pp2btvo****"
      ],
      "us-west-1": [
        "alikafka_pre-cn-i7m2lxid****"
      ],
      "cn-hangzhou": [
        "alikafka_pre-cn-i7m2hflj****",
        "alikafka_pre-cn-zvp2hsje****",
        "alikafka_pre-cn-zvp2kvc9****"
      ]
    }
  ],
  "RequestId": "ABA4A7FD-E10F-45C7-9774-A5236015****",
  "Success": true
}

In this example, the account has instances in three regions: one in cn-shenzhen, one in us-west-1, and three in cn-hangzhou.

Error codes

For a list of error codes, see Common error codes.