DescribeInstanceDetail - 查询实例详情--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DescribeInstanceDetail - 查询实例详情

最近更新时间：2024.11.18 10:27:30首次发布时间：2023.07.12 16:22:34

调用 DescribeInstanceDetail 接口查看指定实例的详情。

使用说明

创建 RocketMQ 实例后，您可以调用 DescribeInstanceDetail 接口查看指定实例的名称、网络类型等详细信息。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeInstanceDetail	要执行的操作，取值：DescribeInstanceDetail。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	待查询详情的实例 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
BasicInfo	Object	/	实例的名称、版本等基本信息。
FileReservedTime	Integer	72	消息保留时长。
ConnectionInfo	Array of Object	/	实例的连接信息。
ChargeDetail	Object	/	付费方式。

请求示例

POST /?Action=DescribeInstanceDetail&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnai1f0c29ca****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023050817381642C835F4A0B6E14831A3",
        "Action": "DescribeInstanceDetail",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "BasicInfo": {
            "AccountId": "2000006376",
            "ApplyPrivateDNSToPublic": false,
            "AvailableQueueNumber": 3944,
            "ChargeDetail": {
                "ChargeExpireTime": "1970-01-01T00:00:00Z",
                "ChargeStatus": "Normal",
                "ChargeType": "PostPaid",
                "OverdueReclaimTime": "1970-01-01T00:00:00Z",
                "OverdueTime": "1970-01-01T00:00:00Z",
                "PeriodUnit": "Monthly"
            },
            "ComputeSpec": "rocketmq.n1.x2.micro",
            "CreateTime": "2023-05-08T09:11:15Z",
            "Defer": false,
            "DiskEncrypted": false,
            "EipId": "eip-22j06qkez64u87r2qr105****",
            "EnableByteProxyRateLimit": false,
            "EnableSSL": true,
            "FileReservedTime": 0,
            "HTTPProxy": false,
            "InstanceDescription": "",
            "InstanceId": "rocketmq-cnai1f0c29ca****",
            "InstanceName": "rocketmq-cnai1f0c29c****",
            "InstanceStatus": "Running",
            "ProjectName": "",
            "RegionId": "cn-shanghai",
            "SSLMode": "enforcing",
            "StorageSpace": 300,
            "StorageType": "flexPL",
            "SubnetId": "subnet-22j3oc7a7rvuo7r2qr29u****",
            "Tags": {
                "tag": "1"
            },
            "UsedGroupNumber": 0,
            "UsedStorageSpace": 0,
            "UsedTopicNumber": 0,
            "Version": "4.8",
            "VpcId": "vpc-3qe3nxqooqccg7prmkznr****",
            "ZoneId": "cn-shanghai-a"
        },
        "ChargeDetail": {
            "ChargeExpireTime": "1970-01-01T00:00:00Z",
            "ChargeStatus": "Normal",
            "ChargeType": "PrePaid",
            "OverdueReclaimTime": "1970-01-01T00:00:00Z",
            "OverdueTime": "1970-01-01T00:00:00Z",
            "PeriodUnit": "Monthly"
        },
        "ConnectionInfo": [
            {
                "EndpointType": "TCP",
                "InternalEndpoint": "http://rocketmq-cnai1f0c29ca****.rocketmq.ivolces.com:9876",
                "NetworkType": "PrivateNetwork",
                "PublicEndpoint": "http://rocketmq-cnai1f0c29ca****.rocketmq.volces.com:9876"
            }
        ],
        "FileReservedTime": 72
    }
}

错误码

公共错误码请参见公共错误码文档。