All Products
Search
Document Center

ApsaraMQ for RocketMQ:ListRegions

Last Updated:Nov 26, 2024

Queries regions in which ApsaraMQ for RocketMQ is available.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /regions HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

Result<List>

requestIdstring

The request ID.

0B962390-D84B-5D44-8C11-79DF40299D41
successboolean

Indicates whether the request was successful.

true
dataarray<object>

The returned data.

dataobject

The regions.

regionIdstring

The region ID.

cn-hangzhou
regionNamestring

The region name.

hangzhou
supportRocketmqV5boolean

Indicates whether ApsaraMQ for RocketMQ V5 is activated.

true
supportRocketmqV4boolean

Indicates whether ApsaraMQ for RocketMQ V4 is activated.

true
createTimestring

The time when the ApsaraMQ for RocketMQ instance was created.

2022-08-01 20:05:50
updateTimestring

The time when the ApsaraMQ for RocketMQ instance was last modified.

2022-08-01 20:05:50
tagsarray<object>

The region tags.

tagsobject

The region tag.

tagCodestring

The tag code.

xx
tagValueany

The tag value.

xx
codestring

The error code.

MissingPageNumber
messagestring

The error message.

Parameter instanceId is mandatory for this action .
httpStatusCodeinteger

The HTTP status code.

200
dynamicCodestring

The dynamic error code.

ConsumerGroupId
dynamicMessagestring

The dynamic error message.

instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "0B962390-D84B-5D44-8C11-79DF40299D41",
  "success": true,
  "data": [
    {
      "regionId": "cn-hangzhou",
      "regionName": "hangzhou",
      "supportRocketmqV5": true,
      "supportRocketmqV4": true,
      "createTime": "2022-08-01 20:05:50",
      "updateTime": "2022-08-01 20:05:50",
      "tags": [
        {
          "tagCode": "xx",
          "tagValue": "xx"
        }
      ]
    }
  ],
  "code": "MissingPageNumber",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "instanceId"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history