Skip to Content
RMQ Message Queue(URocketMQ)GetURocketMQService

GetURocketMQService - GetURocketMQService

Overview

Get the details of the Service with the specified id

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetURocketMQService.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See Region and Availability Zone ListYes
ProjectIdstringProject ID. Please refer to GetProjectList APIYes
ServiceIdstringService IDYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
ServiceListarray[ServiceDetail]Service List, including obtained Service detailsYes

Data Model

ServiceDetail

Field NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ChargeTypestringPayment Type Reference linkYes
ServiceIdstringService IDYes
NamestringNameYes
RemarkstringDescriptionYes
StatestringService Status: Unknown: Unknown, Available: Available, Initializing, Deleting: Deleting, CreateFailed: Creation FailedYes
SubnetIdstringsubnet idYes
ExpireTimeintResource validity period unix timestamp, unit in seconds, corresponding to PurchaseValue”.Yes
AutoRenewstringAuto-renewal 1 Auto-renewal, 0 No auto-renewalYes
StorageintStorage Space, Unit GBYes
TopicLimitintTopic LimitYes
QuantityintPurchase DurationYes
VpcIdstringVpc IdNo
TpsintSpecifications, specific enumeration values to be determinedNo

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" } ] }