Use GetInstance to retrieve instance details - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Retrieves the details of a specified instance.

Operation description

Important The OpenAPI provided by Alibaba Cloud is a management and control API used to manage and query related resources of Alibaba Cloud services. It is recommended only for integration in management and control links. Using OpenAPI in the core data link for message sending and receiving is strictly prohibited. Otherwise, risks may occur on the link.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rocketmq:GetInstance

get

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

GET /instances/{instanceId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance to query.	rmq-cn-7e22ody****

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response data.
requestId	string	The request ID. Each request has a unique ID, which can be used to troubleshoot issues.	05AB7FBD-F1D3-5D87-BF78-BD782249****
success	boolean	Indicates whether the operation is successful.	true
data	object	The response data.
regionId	string	The region ID of the instance.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
instanceName	string	The instance name.	test instance
status	string	The instance status. Valid values: RELEASED : Released. RUNNING : Running. STOPPED : Stopped. CHANGING : Being changed. CREATING : Being created.	RUNNING
startTime	string	The start time of the instance.	2022-08-01 00:00:00
expireTime	string	The expiration time of the instance.	2022-09-01 00:00:00
releaseTime	string	The release time of the instance.	2022-09-07 00:00:00
userId	string	The ID of the user to whom the instance belongs.	111111111111111
bid	string	The sales channel BID of the commodity.	26842
commodityCode	string	The commodity code of the MSMQ for RocketMQ 5.x queue instance, such as ons_rmqsub_public_cn.	ons_rmqsub_public_cn
serviceCode	string	The service encoding of the instance. The service encoding for MSMQ for RocketMQ queue is rmq.	rmq
seriesCode	string	The primary series code of the instance. For differences between primary series, see Product selection. Valid values: standard : Standard Edition. shared : Shared Edition. dedicated : Dedicated Edition. ultimate : Platinum Edition. professional : Professional Edition.	standard
subSeriesCode	string	The sub-series code of the instance. For differences between sub-series, see Product selection. Valid values: serverless : Serverless Edition. cluster_ha : Cluster high-availability Edition. single_node : Single-node Edition.	cluster_ha
paymentType	string	The billing method of the instance. Valid values: PayAsYouGo : Pay-as-you-go (postpaid). Subscription : Subscription (prepaid).	Subscription
remark	string	The remarks of the instance.	This is remark for instance.
networkInfo	object	The network information.
vpcInfo	object	The VPC information.
vpcId	string	The ID of the VPC associated with the instance.	vpc-uf6of9452b2pba82c****
vSwitchId `deprecated`	string	The ID of the vSwitch associated with the instance.	vsw-uf6gwtbn6etadpvz7****
vSwitches	array<object>	The vSwitch list.
	object
vSwitchId	string	The vSwitch ID.	vsw-uf6gwtbn6etadpvz7****
zoneId	string	The zone ID.	cn-hangzhou
securityGroupIds	string	The security group ID.	sg-hp35r2hc3a3sv8q2sb16
endpoints	array<object>	The endpoint information.
	object	The endpoint information.
endpointType	string	The endpoint type of the instance. Valid values: TCP_VPC : VPC endpoint. TCP_INTERNET : Public endpoint.	TCP_INTERNET
endpointUrl	string	The endpoint of the instance.	rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080
ipWhitelist	array	The IP whitelist for public network access. Only public endpoints support IP whitelist configuration. VPC endpoints do not support this feature.	192.168.x.x/24
	string	The IP whitelist for public network access.	192.168.x.x/24
endpointId	string	The associated PVL EP instance.	ep-bpxxx
internetInfo	object	The public network information of the instance.
internetSpec	string	Specifies whether public network access is enabled. Valid values: enable : Public network access enabled. disable : Public network access disabled.	enable
flowOutType	string	The public network billing type. Valid values: payByBandwidth : Fixed bandwidth billing. Set this value when public network access is enabled. uninvolved : Not applicable. Set this value when public network access is not enabled.	payByBandwidth
flowOutBandwidth	integer	The Internet bandwidth specification. Unit: 1 Mbit/s.	1
ipWhitelist	array	The IP whitelist for public network access.
	string	The IP whitelist for public network access.	192.168.x.x/24
accountInfo	object	The account information.
username	string	The username of the instance. When using public network access, configure the username and password of the instance in the SDK code for identity verification to authenticate the client.	6W0xz2uPfiwp****
instanceQuotas	array<object>	The capacity information.
	object	The capacity information.
quotaName	string	The quota name of the instance. Valid values: TOPIC_COUNT : Topic creation quota of the instance.	TOPIC_COUNT
usedCount	number	The used count. Unit: count.	10
freeCount	number	The free quota. Unit: count.	20
totalCount	number	The total quota. Unit: count.	100
createTime	string	The creation time of the instance.	2022-08-01 00:00:00
updateTime	string	The last modification time of the instance.	2022-08-02 00:00:00
extConfig `deprecated`	object	The extended configuration. This field is deprecated. Use the productInfo, internetInfo, and aclInfo fields instead.
aclType	string	The authentication type of the instance. Valid values: default : Intelligent identity recognition. apache_acl : Apache RocketMQ ACL	default
sendReceiveRatio	number	The ratio of message sending to receiving.	0.5
autoScaling	boolean	Specifies whether out-of-specification burstable elastic capability is enabled. Valid values: true : Elastic capability enabled. false : Elastic capability not enabled.	true
messageRetentionTime	integer	The message retention period. Unit: hours.	72
supportAutoScaling	boolean	Indicates whether the instance supports out-of-specification burstable elastic capability. Valid values: true : Supports enabling elastic capability. false : Does not support enabling elastic capability.	true
internetSpec	string	Specifies whether public network access is enabled. Valid values: enable : Public network access enabled. disable : Public network access disabled.	enable
flowOutType	string	The public network billing type. Valid values: payByTraffic : Pay-by-traffic. payByBandwidth : Pay-by-bandwidth. uninvolved : Not applicable.	payByBandwidth
flowOutBandwidth	integer	The Internet bandwidth specification. Unit: Mbit/s.	10
msgProcessSpec	string	The message send/receive compute specification. For the specific TPS limits, refer to Instance specifications.	rmq.s2.2xlarge
resourceGroupId	string	The resource group ID.	rg-acfm3tmjruyribi
productInfo	object	The extended configuration of the instance.
msgProcessSpec	string	The message send/receive compute specification. For the specific TPS limits, refer to Instance specifications.	rmq.s2.2xlarge
sendReceiveRatio	number	The ratio of message sending to receiving.	0.5
autoScaling	boolean	Specifies whether out-of-specification burstable elastic capability is enabled. Valid values: true : Elastic capability enabled. false : Elastic capability not enabled.	true
messageRetentionTime	integer	The message retention period. Unit: hours.	72
supportAutoScaling	boolean	Indicates whether out-of-specification burstable elastic capability is supported. Valid values: true : Supports enabling elastic capability. false : Does not support enabling elastic capability.	true
traceOn	boolean	Indicates whether the message trace feature is enabled.	true
storageEncryption	boolean	Indicates whether storage encryption is enabled.	false
storageSecretKey	string	The storage encryption key.	xxxxx
capacityType	string	The capacity mode. Valid values: provisioned : Provisioned + elastic. ondemand : Pay-as-you-go.	provisioned
provisionedCapacity	integer	The provisioned capacity.	3000
drReplicationMode	string	The cross-region replication mode.	async_cross_az
maxDelayTime	integer	The maximum interval for scheduled messages. Unit: seconds.	3456000
adaptiveElasticity	boolean		false
aclInfo	object	The access control information.
aclTypes	array	The list of authentication types for the instance.
	string	The authentication type of the instance. Valid values: default : Intelligent identity recognition. apache_acl : ACL identity recognition.	default
defaultVpcAuthFree	boolean	Specifies whether authentication-free access over the internal network is enabled. Valid values: true : Enabled. false : Disabled.	true
aclType `deprecated`	string	The authentication type of the instance. This field is deprecated. Use the aclTypes field instead. Valid values: default : Intelligent identity recognition. apache_acl : ACL identity recognition.	default
software	object	The instance software information.
softwareVersion	string	The software version.	5.0-rmq-20230619-1
maintainTime `deprecated`	string	The maintenance window for upgrades.	02:00-06:00
upgradeMethod	string	The upgrade method. Valid values: auto : Automatic upgrade. maunal : Manual upgrade.	auto
topicCount	integer	The number of topics.	10
groupCount	integer	The number of consumer groups.	10
tags	array<object>	The list of resource tags.
	object	The resource tag.
key	string	The tag key of the resource.	key
value	string	The tag value of the resource.	value
autoRenew	boolean	Indicates whether auto-renewal is enabled.	false
autoRenewPeriod	integer	Indicates whether auto-renewal is enabled.	false
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Success response

JSON format

{
  "requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "instanceName": "test instance",
    "status": "RUNNING",
    "startTime": "2022-08-01 00:00:00",
    "expireTime": "2022-09-01 00:00:00",
    "releaseTime": "2022-09-07 00:00:00",
    "userId": "111111111111111",
    "bid": "26842",
    "commodityCode": "ons_rmqsub_public_cn",
    "serviceCode": "rmq",
    "seriesCode": "standard",
    "subSeriesCode": "cluster_ha",
    "paymentType": "Subscription",
    "remark": "This is remark for instance.",
    "networkInfo": {
      "vpcInfo": {
        "vpcId": "vpc-uf6of9452b2pba82c****",
        "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
        "vSwitches": [
          {
            "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
            "zoneId": "cn-hangzhou"
          }
        ],
        "securityGroupIds": "sg-hp35r2hc3a3sv8q2sb16"
      },
      "endpoints": [
        {
          "endpointType": "TCP_INTERNET",
          "endpointUrl": "rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080",
          "ipWhitelist": [
            "192.168.x.x/24"
          ],
          "endpointId": "ep-bpxxx"
        }
      ],
      "internetInfo": {
        "internetSpec": "enable",
        "flowOutType": "payByBandwidth",
        "flowOutBandwidth": 1,
        "ipWhitelist": [
          "192.168.x.x/24"
        ]
      }
    },
    "accountInfo": {
      "username": "6W0xz2uPfiwp****"
    },
    "instanceQuotas": [
      {
        "quotaName": "TOPIC_COUNT",
        "usedCount": 10,
        "freeCount": 20,
        "totalCount": 100
      }
    ],
    "createTime": "2022-08-01 00:00:00 ",
    "updateTime": "2022-08-02 00:00:00 ",
    "extConfig": {
      "aclType": "default",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "internetSpec": "enable",
      "flowOutType": "payByBandwidth",
      "flowOutBandwidth": 10,
      "msgProcessSpec": "rmq.s2.2xlarge"
    },
    "resourceGroupId": "rg-acfm3tmjruyribi",
    "productInfo": {
      "msgProcessSpec": "rmq.s2.2xlarge",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "traceOn": true,
      "storageEncryption": false,
      "storageSecretKey": "xxxxx",
      "capacityType": "provisioned",
      "provisionedCapacity": 3000,
      "drReplicationMode": "async_cross_az",
      "maxDelayTime": 3456000,
      "adaptiveElasticity": false
    },
    "aclInfo": {
      "aclTypes": [
        "default"
      ],
      "defaultVpcAuthFree": true,
      "aclType": "default"
    },
    "software": {
      "softwareVersion": "5.0-rmq-20230619-1",
      "maintainTime": "02:00-06:00",
      "upgradeMethod": "auto"
    },
    "topicCount": 10,
    "groupCount": 10,
    "tags": [
      {
        "key": "key",
        "value": "value"
      }
    ],
    "autoRenew": false,
    "autoRenewPeriod": 0
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.