DescribeInstances - 获取当前实例列表--消息队列 RabbitMQ版-火山引擎

文档中心

导航

DescribeInstances - 获取当前实例列表

最近更新时间：2024.11.18 10:21:06首次发布时间：2023.05.19 15:47:10

调用 DescribeInstances 接口获取当前账户下的实例列表。

使用说明

DescribeInstances 是分页式的查询接口，返回符合筛选条件的 RabbitMQ 实例列表及概览信息。如需获取指定 RabbitMQ 实例的详细信息，可以指定实例 ID 进行查询，或直接使用 DescribeInstanceDetail 接口。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeInstances	要执行的操作，取值：DescribeInstances。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
PageNumber	Integer	是	1	查询结果分页展示时，此参数用于表示页码。支持的最小值为1。
PageSize	Integer	是	10	查询结果分页展示时，此参数用于表示每页的数据量。取值范围为1~100。
VpcId	String	否	myvpc	实例所在的 VPC 名称。支持模糊匹配。
ChargeType	String	否	PostPaid	实例的付费类型。精确查询。支持设置为： PostPaid：按量付费 PrePaid：包年包月
ZoneId	String	否	cn-beijing-a	实例所在的可用区 ID。模糊匹配。
InstanceStatus	String	否	Running	实例当前的状态。精确查询。
InstanceName	String	否	test-instance	实例名称。支持模糊匹配。
Spec	String	否	rabbitmq.n3.x2.medium	实例的计算规格。精确查询。消息队列 RabbitMQ版实例提供的计算规格清单，请参考产品规格。
ProjectName	String	否	default	根据实例所属的 IAM 项目进行筛选。不指定此参数时，返回该操作账号具备查看权限的实例列表。
TagFilters	Array of Object	否	/	根据实例的标签进行筛选。
InstanceId	String	否	rbtmq-5b293870****	实例 ID。指定实例 ID 时，表示查看指定实例的信息，此时 InstanceName 等其他筛选项不生效。支持模糊匹配。

返回参数

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

参数	类型	示例值	描述
Total	Integer	2	实例总数。
InstancesInfo	Array of Object	/	实例的名称、版本等基本信息。

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=DescribeInstances&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=********

{
    "PageSize":10,
    "PageNumber":1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230217143155B04E2C25D739C689****",
        "Action": "DescribeInstances",
        "Version": "2022-01-01",
        "Service": "RabbitMQ",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstancesInfo": [
            {
                "ArchType": "Cluster",
                "ChargeDetail": {
                    "ChargeEndTime": "1970-01-01 08:00:00 +0800 CST",
                    "ChargeStartTime": "2022-05-31 18:47:38 +0800 CST",
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid"
                },
                "ComputeSpec": "rabbitmq.n3.x2.medium",
                "CreateTime": "1653994058",
                "InstanceDescription": "",
                "InstanceId": "rbtmq-928c0619****",
                "InstanceName": "勿删",
                "InstanceStatus": "Running",
                "ProjectName": "default",
                "RegionDescription": "",
                "RegionId": "cn-beijing",
                "StorageSpace": 500,
                "SubnetId": "subnet-13fvfm1q5rpq83n6nu5ep****",
                "UsedStorageSpace": 11,
                "Version": "3.8.18",
                "VpcId": "vpc-rs5811nceqyov0x58x4****",
                "ZoneDescription": "华北2（北京）-可用区A",
                "ZoneId": "cn-beijing-a"
            },
            {
                "ArchType": "Cluster",
                "ChargeDetail": {
                    "ChargeEndTime": "1970-01-01 08:00:00 +0800 CST",
                    "ChargeStartTime": "2022-06-29 11:10:05 +0800 CST",
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid"
                },
                "ComputeSpec": "rabbitmq.n3.x2.medium",
                "CreateTime": "1656472205",
                "InstanceDescription": "",
                "InstanceId": "rbtmq-5b293870****",
                "InstanceName": "勿删-azB",
                "InstanceStatus": "Running",
                "ProjectName": "default",
                "RegionDescription": "",
                "RegionId": "cn-beijing",
                "StorageSpace": 1000,
                "SubnetId": "subnet-rs302h1mqrr4v0x57kq****",
                "Tags": {
                    "勿删-wzy": "123123"
                },
                "UsedStorageSpace": 19,
                "Version": "3.8.18",
                "VpcId": "vpc-rs5811nceqyov0x58x4****",
                "ZoneDescription": "华北2（北京）-可用区B",
                "ZoneId": "cn-beijing-b"
            }
        ],
        "Total": 2
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。