OnsInstanceBaseInfo - ApsaraMQ for RocketMQ - Alibaba Cloud ドキュメントセンター

Queries the basic information of a ApsaraMQ for RocketMQ instance and the endpoint that a client uses to connect to the ApsaraMQ for RocketMQ instance to send and receive messages.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

To send and receive messages, a client must be connected to a ApsaraMQ for RocketMQ instance by using an endpoint. You can call this operation to query the endpoints of the instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mq:OnsInstanceBaseInfo	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance that you want to query.	MQ_INST_138015630679****_BAAy1Hac

Response parameters

Parameter	Type	Description	Example
	object
InstanceBaseInfo	object	The information about the instance.
Endpoints	object	The endpoints used to access ApsaraMQ for RocketMQ over different protocols.
TcpEndpoint	string	The private TCP endpoint of the instance.	http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080
TcpInternetEndpoint	string	The public TCP endpoint of the instance. Only instances that are deployed in the China (Chengdu), China (Qingdao), or China (Shenzhen) region can be accessed by using public TCP endpoints. Before you use a public TCP endpoint, make sure that your client SDK meets the following requirements: TCP client SDK for Java: V2.0.0.Final or later For more information, see Release notes for the SDK for Java. TCP client SDK for C++: V3.0.0 or later For more information, see Release notes for the SDK for C++. You are charged for Internet traffic when you use a public TCP endpoint. For more information, see Internet traffic fee.	http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80
HttpInternetEndpoint	string	The public HTTP endpoint of the instance.	http://138015630679****.mqrest.cn-chengdu.aliyuncs.com
HttpInternalEndpoint	string	The private HTTP endpoint of the instance.	http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com
HttpInternetSecureEndpoint	string	The public HTTPS endpoint of the instance.	https://138015630679****.mqrest.cn-chengdu.aliyuncs.com
IndependentNaming	boolean	Indicates whether the instance uses a namespace. Valid values: true: The instance uses a separate namespace. The name of each resource must be unique in the instance. The names of resources in different instances can be the same. false: The instance does not use a separate namespace. The name of each resource must be globally unique within the instance and across all instances.	true
MaxTps	long	The maximum messaging transactions per second (TPS). Valid values: 5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000, and 1000000. You can view the details about messaging TPS on the buy page of ApsaraMQ for RocketMQ. Note This parameter is available only to the ApsaraMQ for RocketMQ Enterprise Platinum Edition instances.	10000
Remark	string	The description of the instance.	ons-cn-m7r1r5f****
InstanceName	string	The name of the instance. The name must be 3 to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (_).	test
ReleaseTime	long	The time when the Enterprise Platinum Edition instance expires.	1603555200000
TopicCapacity	integer	The maximum number of topics that can be created on the instance. Valid values: 25, 50, 100, 300, and 500. Note This parameter is available only to the ApsaraMQ for RocketMQ Enterprise Platinum Edition instances.	50
InstanceStatus	integer	The status of the instance. Valid values: 0: The instance is being deployed. This value is valid only for Enterprise Platinum Edition instances. 2: The instance has overdue payments. This value is valid only for Standard Edition instances. 5: The instance is running. This value is valid for Standard Edition instances and Enterprise Platinum Edition instances. 7: The instance is being upgraded and is running. This value is valid only for Enterprise Platinum Edition instances.	5
InstanceId	string	The ID of the instance	MQ_INST_138015630679****_BAAy1Hac
InstanceType	integer	The instance type. Valid values: 1: Standard Edition instances that use the pay-as-you-go billing method. 2: Enterprise Platinum Edition instances that use the subscription billing method. For information about the editions and specifications of ApsaraMQ for RocketMQ instances, see Instance editions.	2
CreateTime	string	The time when the instance was created. The value of this parameter is a UNIX timestamp in milliseconds.	1570701259403
spInstanceId	string	The commodity ID of the instance.	ons-cn-m7r1r5f****
spInstanceType	integer	The commodity type of the instance. Enumeration Value: 1: . 2: .	1
RequestId	string	The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.	6CC46974-65E8-4C20-AB07-D20D102E****

Examples

Sample success responses

JSONformat

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