GetURocketMQService - GetURocketMQService
Overview
Get the details of the Service with the specified id
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetURocketMQService . | Yes |
PublicKey | string | The user’s public key can be obtained from Console | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See Region and Availability Zone List | Yes |
ProjectId | string | Project ID. Please refer to GetProjectList API | Yes |
ServiceId | string | Service ID | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
ServiceList | array[ServiceDetail] | Service List, including obtained Service details | Yes |
Data Model
ServiceDetail
Field Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
ChargeType | string | Payment Type Reference link | Yes |
ServiceId | string | Service ID | Yes |
Name | string | Name | Yes |
Remark | string | Description | Yes |
State | string | Service Status: Unknown: Unknown, Available: Available, Initializing, Deleting: Deleting, CreateFailed: Creation Failed | Yes |
SubnetId | string | subnet id | Yes |
ExpireTime | int | Resource validity period unix timestamp, unit in seconds, corresponding to PurchaseValue”. | Yes |
AutoRenew | string | Auto-renewal 1 Auto-renewal, 0 No auto-renewal | Yes |
Storage | int | Storage Space, Unit GB | Yes |
TopicLimit | int | Topic Limit | Yes |
Quantity | int | Purchase Duration | Yes |
VpcId | string | Vpc Id | No |
Tps | int | Specifications, specific enumeration values to be determined | No |
Example
Request Example
https://api.ucloud-global.com/?Action=GetURocketMQService
&Region=cn-zj
&ProjectId=YOesiTGQ
&ServiceId=uptNNggM
Response Example
{
"Action": "GetURocketMQServiceResponse",
"Message": "GMvPZNMW",
"RetCode": 0,
"ServiceList": [
{
"AutoRenew": 2,
"ChargeType": 2,
"ExpireTime": 8,
"Name": "GRmqkdLR",
"OrderTime": 6,
"Region": "cn-zj",
"Remark": "sgfvJPxX",
"ServiceId": "SaSKkdku",
"State": "BwugeEiA",
"Storage": 4,
"SubnetId": "unORiqlR",
"TPS": 4,
"TopicCount": 4,
"VPCId": "TGWNXarO"
}
]
}