API Introduction
This API is used to query basic instance information and endpoints for sending and receiving messages.
API Restrictions
None.
URl
GET https://[endpoint]/v2/instance/baseInfo
Request Parameters
Request Parameters | Required or Not | Position | Parameter Type | Description |
prodInstId | Yes | url | String | Instance ID |
Response Parameter
Response Parameter | Parameter Type | Description |
statusCode | String | The status code of the interface on the system layer. Success: 800; failure: 900. |
message | String | Status Description |
returnObj | String | Return the object. The parameters included in this parameter are described in the comments in Response Examples. |
Description of Return Value returnObj
Response Parameter | Parameter Type | Description |
instanceBaseInfo | List | Instance Information |
Description of Return Value instanceBaseInfo
Response Parameter | Parameter Type | Description |
prodInstId | String | Instance ID |
billMode | String | Billing Modes 1: subscription-based 2: pay-as-you-go |
prodInstName | String | Instance Name |
runningState | String | Instance Status: Running Unsubscribed |
prodType | String | Specification Name |
machineSpec | String | ECS Type |
tpsLimit | String | TPS Peak |
topicLimit | String | Max Number of Topics |
diskSpace | String | Disk Space |
netName | String | Network Name |
subnet | String | Subnet |
securityGroup | String | Security Group |
expTime | Long | Expired at |
crtTime | Long | Created at |
prodInstId | String | Instance ID |
billMode | String | Billing Modes 1: subscription-based 2: pay-as-you-go |
prodInstName | String | Instance Name |
runningState | String | Instance Status: Running Unsubscribed |
prodType | String | Specification Name |
machineSpec | String | ECS Type |
tpsLimit | String | TPS Peak |
topicLimit | String | Max Number of Topics |
diskSpace | String | Disk Space |
netName | String | Network Name |
subnet | String | Subnet |
securityGroup | String | Security Group |
expTime | Long | Expired at |
crtTime | Long | Created at |
nameServer | String | Namesrv Address |
Sample Request
GET https://[endpoint]/v2/instance/baseInfo?prodInstId=70687660456281088
Examples of a Successful Response
{
"returnObj":{
"instanceBaseInfo":{
"prodInstId":"mq_test",
"billMode":"1",
"prodInstName":"70687660456281089",
"runningState":"Running",
"prodType":"Others",
"machineSpec":"4-core 16G",
"tpsLimit":"20000",
"topicLimit":"500",
"diskSpace":"1000G",
"netName":null,
"subnet":null,
"securityGroup":null,
"expTime":1661858849638,
"nameServer":"192.168.71.188:8411",
"crtTime":1652841984000
}
},
"message":"success",
"statusCode":800
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}