调用 DescribeInstanceDetail 接口查看指定实例的详情。
请求频率:该接口请求频率限制为 100 次/秒;单用户请求频率限制为 20 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstanceDetail | 要执行的操作,取值:DescribeInstanceDetail。 |
Version | String | 是 | 2022-01-01 | API的版本,取值:2022-01-01。 |
InstanceId | String | 是 | rbtmq-5b293870**** | 待查询详情的 RabbitMQ 实例 ID。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
BasicInstanceInfo | Object | / | 实例的名称、版本等基本信息。 |
Endpoints | Array of Object | / | 实例的连接信息。 |
POST https://rabbitmq.volcengineapi.com/?Action=DescribeInstanceDetail&Version=2022-01-01 HTTP/1.1 Accept: application/json Content-Type: application/json Host: rabbitmq.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rabbitmq/request, SignedHeaders=x-date, Signature=******** { "InstanceId": "rbtmq-bdb8a520****" }
{ "ResponseMetadata": { "RequestId": "20230220223226D0ACEF02D32FFCE8AB00", "Action": "DescribeInstanceDetail", "Version": "2022-01-01", "Service": "RabbitMQ", "Region": "cn-guangzhou" }, "Result": { "BasicInfo": { "ApplyPrivateDNSToPublic": false, "ArchType": "Cluster", "ChargeDetail": { "ChargeStartTime": "1654485759", "ChargeStatus": "Normal", "ChargeType": "PostPaid" }, "ComputeSpec": "rabbitmq.n3.x2.medium", "CreateTime": "1654485759", "EipId": "eip-3ez7smk9xdszk72200swh****", "InitUserName": "wangziyi", "InstanceDescription": "", "InstanceId": "rbtmq-4e688d7d****", "InstanceName": "勿删-长稳IO测试实例-azA", "InstanceStatus": "Running", "IsEncrypted": false, "ProjectName": "default", "RegionDescription": "华南1(广州)", "RegionId": "cn-guangzhou", "StorageSpace": 1000, "SubnetId": "subnet-3ezlsilsuu68072200t33****", "UsedStorageSpace": 346, "Version": "3.8.18", "VpcId": "vpc-11woocw780tfk40yrhcc2****", "ZoneDescription": "华南1(广州)-可用区A", "ZoneId": "cn-guangzhou-a" }, "Endpoints": [ { "EndpointType": "WEB", "InternalEndpoint": "http://rbtmq-4e688d7d****.rabbitmq.ivolces.com:15672", "NetworkType": "PrivateNetwork", "PublicEndpoint": "https://rbtmq-4e688d7d****.rabbitmq.volces.com:15671" }, { "EndpointType": "AMQP0_9_1", "InternalEndpoint": "rbtmq-4e688d7d****.rabbitmq.ivolces.com:5672", "NetworkType": "PrivateNetwork", "PublicEndpoint": "rbtmq-4e688d7d****.rabbitmq.volces.com:5671" }, { "EndpointType": "MQTT", "InternalEndpoint": "rbtmq-4e688d7d****.rabbitmq.ivolces.com:1883", "NetworkType": "PrivateNetwork", "PublicEndpoint": "rbtmq-4e688d7d****.rabbitmq.volces.com:8883" }, { "EndpointType": "WEB_MQTT", "InternalEndpoint": "ws://rbtmq-4e688d7d****.rabbitmq.ivolces.com:15675", "NetworkType": "PrivateNetwork", "PublicEndpoint": "wss://rbtmq-4e688d7d****.rabbitmq.volces.com:15676" }, { "EndpointType": "STOMP", "InternalEndpoint": "rbtmq-4e688d7d****.rabbitmq.ivolces.com:61613", "NetworkType": "PrivateNetwork", "PublicEndpoint": "rbtmq-4e688d7d****.rabbitmq.volces.com:61614" } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | InvalidParameter | 参数值%s无效。 |
403 | OperationDenied.AccountNotAuthorized | 您不具备相关权限 ,请授权或切换账号后重试。 |
404 | InvalidInstanceId.NotFound | 实例不存在。 |
500 | InternalError | 内部错误,请稍后重试。 |