Queries the basic information of a Message Queue for Apache RocketMQ instance and the endpoints for sending and subscribing to messages.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Required OnsInstanceBaseInfo

The operation that you want to perform. Set the value to OnsInstanceBaseInfo.

InstanceId String Required MQ_INST_138015630679****_BAAy1Hac

The ID of the Message Queue for Apache RocketMQ instance that you want to query.

Response parameters

Parameter Type Example Description
InstanceBaseInfo Struct

The returned information object of the Message Queue for Apache RocketMQ instance that was queried.

Endpoints Struct

The endpoint that corresponds to each protocol in the Message Queue for Apache RocketMQ instance.

HttpInternalEndpoint String http://138015630679****.mqrest.cn-zhangjiakou-internal.aliyuncs.com

The internal HTTP endpoint for the Message Queue for Apache RocketMQ instance.

HttpInternetEndpoint String http://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com

The Internet HTTP endpoint for the Message Queue for Apache RocketMQ instance.

HttpInternetSecureEndpoint String https://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com

The Internet HTTPS endpoint for the Message Queue for Apache RocketMQ instance.

TcpEndpoint String http://MQ_INST_138015630679****_BAAy1Hac.cn-zhangjiakou.mq-internal.aliyuncs.com:8080

The TCP endpoint for the Message Queue for Apache RocketMQ instance.

IndependentNaming Boolean true

Indicates whether a namespace is configured for the Message Queue for Apache RocketMQ instance. Valid values:

  • true: A separate namespace is configured for the Message Queue for Apache RocketMQ instance. Resource names must be unique within the instance but can be the same across different instances.
  • false: No separate namespaces are configured for the Message Queue for Apache RocketMQ instance. Resource names must be globally unique across all instances.
InstanceId String MQ_INST_138015630679****_BAAy1Hac

The ID of the Message Queue for Apache RocketMQ instance.

InstanceName String test

The name of the Message Queue for Apache RocketMQ instance.

The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (_).

InstanceStatus Integer 5

The status of the Message Queue for Apache RocketMQ instance. Valid values:

  • 0: An Enterprise Platinum Edition instance is being deployed.
  • 2: A pay-as-you-go instance is overdue.
  • 5: A pay-as-you-go or Enterprise Platinum Edition instance is running.
  • 7: An Enterprise Platinum Edition instance is being upgraded and is available.
InstanceType Integer 2

The type of the Message Queue for Apache RocketMQ instance. Valid values:

  • 1: Pay-as-you-go
  • 2: Enterprise Platinum Edition
MaxTps Long 10000

The maximum transactions per second (TPS) for sending and receiving messages. Valid values:

5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000, and 1000000.

For more information, see the description on the buy page.

Note This parameter is only applicable to the Enterprise Platinum Edition of Message Queue for Apache RocketMQ instances.
ReleaseTime Long 1603555200000

The time when the Enterprise Platinum Edition instance expires.

Remark String test

The description of the Message Queue for Apache RocketMQ instance.

TopicCapacity Integer 50

The maximum number of topics that can be created on the Message Queue for Apache RocketMQ instance. Valid values:

25, 50, 100, 300, and 500.

Note This parameter is only applicable to the Enterprise Platinum Edition of Message Queue for Apache RocketMQ instances.
RequestId String 6CC46974-65E8-4C20-AB07-D20D102E****

The ID of the request.

Examples

Sample requests

http(s)://ons.cn-zhangjiakou.aliyuncs.com/? Action=OnsInstanceBaseInfo
&InstanceId=MQ_INST_138015630679****_BAAy1Hac
&<Common request parameters>

Sample success responses

XML format

<InstanceBaseInfoResponse>
  <InstanceBaseInfo>
        <InstanceName>test</InstanceName>
        <MaxTps>10000</MaxTps>
        <Endpoints>
              <HttpInternalEndpoint>http://138015630679****.mqrest.cn-zhangjiakou-internal.aliyuncs.com</HttpInternalEndpoint>
              <TcpEndpoint>http://MQ_INST_138015630679****_BAAy1Hac.cn-zhangjiakou.mq-internal.aliyuncs.com:8080</TcpEndpoint>
              <HttpInternetEndpoint>http://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com</HttpInternetEndpoint>
              <HttpInternetSecureEndpoint>https://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com</HttpInternetSecureEndpoint>
        </Endpoints>
        <TopicCapacity>50</TopicCapacity>
        <InstanceId>MQ_INST_138015630679****_BAAy1Hac</InstanceId>
        <ReleaseTime>1603555200000</ReleaseTime>
        <InstanceStatus>5</InstanceStatus>
        <IndependentNaming>true</IndependentNaming>
        <InstanceType>2</InstanceType>
        <Remark>onspre-cn-m7r1r5f****</Remark>
  </InstanceBaseInfo>
  <RequestId>6CC46974-65E8-4C20-AB07-D20D102E****</RequestId>
</InstanceBaseInfoResponse>

JSON format

{
	"InstanceBaseInfo": {
		"InstanceName": "test",
		"MaxTps": 10000,
		"Endpoints": {
			"HttpInternalEndpoint": "http://138015630679****.mqrest.cn-zhangjiakou-internal.aliyuncs.com",
			"TcpEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.cn-zhangjiakou.mq-internal.aliyuncs.com:8080",
			"HttpInternetEndpoint": "http://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com",
			"HttpInternetSecureEndpoint": "https://138015630679****.mqrest.cn-zhangjiakou.aliyuncs.com"
		},
		"TopicCapacity": 50,
		"InstanceId": "MQ_INST_138015630679****_BAAy1Hac",
		"ReleaseTime": 1603555200000,
		"InstanceStatus": 5,
		"IndependentNaming": true,
		"InstanceType": 2,
		"Remark": "onspre-cn-m7r1r5f****"
	},
	"RequestId": "6CC46974-65E8-4C20-AB07-D20D102E****"
}

Error codes

For a list of error codes, visit the API Error Center.