You need to enable JavaScript to run this app.
导航

GetInstance

最近更新时间2023.07.12 16:47:03

首次发布时间2021.08.30 16:57:44

调用 GetInstance 接口查看指定 RocketMQ 实例的详细信息。

使用说明

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

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

必选

MQ_INST_*******

实例 ID。

响应参数

参数

参数类型

说明

Instance

InstanceDetail

RocketMQ实例的详细信息。
详细信息请参考 InstanceDetail

示例

请求示例

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

{
  "InstanceId": "MQ_INST_********"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "****",
        "Action": "GetInstance",
        "Version": "2021-04-01",
        "Service": "RocketMQ",
        "Region": "cn-beijing"
    },
    "Result": {
        "Instance": {
            "AkSkCount": 0,
            "AutoReNew": false,
            "ChargeStatus": "Normal",
            "ChargeSubType": "Monthly",
            "ChargeType": "PostPaid",
            "ComputeResource": {
                "NormType": "rocketmq.n1.x2.medium"
            },
            "CreateTime": 1650892326,
            "Description": "",
            "DiskUsage": {
                "Total": 600,
                "Used": 0
            },
            "FileReservedTime": 168,
            "GroupCount": 0,
            "HttpAccessPoint": [],
            "InstanceId": "MQ_INST_***",
            "InstanceName": "test-113new",
            "Nets": [
                {
                    "NetworkType": "PublicNetWork",
                    "PublicNet": {
                        "EipIDs": [
                            "eip-***",
                            "eip-***",
                            "eip-***",
                            "eip-***"
                        ],
                        "Status": "Running",
                        "SubnetID": "subnet-***",
                        "VpcID": "vpc-***"
                    }
                }
            ],
            "ProjectName": "test_project",
            "RocketMQVersion": "4.8",
            "Status": "Running",
            "StorageResource": {
                "NormType": "高速存储",
                "Value": 600
            },
            "SubnetID": "subnet-***",
            "Tags": [],
            "TcpAccessPoint": [
                {
                    "Endpoint": "http://MQ_INST_***.rocketmq.ivolces.com:9876",
                    "Network": "Private",
                    "NetworkType": "Exclusive",
                    "Protocol": "TCP"
                },
                {
                    "Endpoint": "http://MQ_INST_***.rocketmq.volces.com:9876",
                    "Network": "Public",
                    "NetworkType": "PublicNetWork",
                    "Protocol": "TCP"
                }
            ],
            "TopicCount": 0,
            "Type": "Exclusive",
            "VpcId": "vpc-****",
            "VpcName": "MQtestVPC",
            "VpcNetwork": "Exclusive",
            "Zone": {
                "Description": "华北2(北京)-可用区A",
                "Name": "cn-beijing-a"
            }
        }
    }
}