You can call this operation to query the basic information of a Message Queue for Apache RocketMQ instance and the endpoints for sending and receiving 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 Yes OnsInstanceBaseInfo

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

InstanceId String Yes MQ_INST_111111111111_DOxxxxxx

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 corresponding to each protocol in the Message Queue for Apache RocketMQ instance.

HttpInternalEndpoint String http://111111111111.mqrest.cn-qingdao-internal.aliyuncs.com

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

HttpInternetEndpoint String http://111111111111.mqrest.cn-qingdao-public.aliyuncs.com

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

HttpInternetSecureEndpoint String https://111111111111.mqrest.cn-qingdao-internal.aliyuncs.com

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

TcpEndpoint String http://MQ_INST_111111111111_DOxxxxxx.mq-internet-access.mq-internet.aliyuncs.com:80

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

IndependentNaming Boolean true

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

  • true: An independent namespace is configured for the Message Queue for Apache RocketMQ instance. Resource names must be unique within the Message Queue for Apache RocketMQ instance but can be the same across different Message Queue for Apache RocketMQ instances.
  • false: No independent namespace is configured for the Message Queue for Apache RocketMQ instance. Resource names must be globally unique across all Message Queue for Apache RocketMQ instances.
InstanceId String MQ_INST_111111111111_DOxxxxxx

The ID of the Message Queue for Apache RocketMQ instance.

Instance name String test

The name of the Message Queue for Apache RocketMQ instance.

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 1

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

  • 1: pay-as-you-go
  • 2: Enterprise Platinum Edition
ReleaseTime Long 1575392461

The time when the Enterprise Platinum Edition instance expires.

Remark String test

The description of the Message Queue for Apache RocketMQ instance.

RequestId String E0D8CCBC-F741-4C06-BB09-81DB7756B5C2

The ID of the request. This is a common parameter.

Examples

Sample requests

http(s)://[Endpoint]/? Action=OnsInstanceBaseInfo
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<Common request parameters>

Sample success responses

XML format

<OnsInstanceBaseInfoResponse>
  <InstanceBaseInfo>
        <InstanceStatus>5</InstanceStatus>
        <Endpoints>
              <HttpInternalEndpoint></HttpInternalEndpoint>
              <HttpInternetEndpoint>http://111111111111.mqrest.cn-qingdao-public.aliyuncs.com</HttpInternetEndpoint>
              <HttpInternetSecureEndpoint></HttpInternetSecureEndpoint>
              <TcpEndpoint>http://MQ_INST_111111111111_DOxxxxxx.mq-internet-access.mq-internet.aliyuncs.com:80</TcpEndpoint>
        </Endpoints>
        <IndependentNaming>true</IndependentNaming>
        <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
        <Remark>test</Remark>
        <InstanceName>test</InstanceName>
        <InstanceType>1</InstanceType>
  </InstanceBaseInfo>
  <HelpUrl></HelpUrl>
  <RequestId>E0D8CCBC-F741-4C06-BB09-81DB7756B5C2</RequestId>
</OnsInstanceBaseInfoResponse>

JSON format

{
	"InstanceBaseInfo": {
		"InstanceStatus": 5,
		"Endpoints": {
			"HttpInternalEndpoint": "",
			"HttpInternetEndpoint": "http://111111111111.mqrest.cn-qingdao-public.aliyuncs.com",
			"HttpInternetSecureEndpoint": "",
			"TcpEndpoint": "http://MQ_INST_111111111111_DOxxxxxx.mq-internet-access.mq-internet.aliyuncs.com:80"
		},
		"IndependentNaming": true,
		"InstanceId": "MQ_INST_111111111111_DOxxxxxx",
		"Remark": "test",
		"InstanceName": "test",
		"InstanceType": 1
	},
	"HelpUrl": "",
	"RequestId": "E0D8CCBC-F741-4C06-BB09-81DB7756B5C2"
}

Error codes

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