批量查询可用实例
1.通过此接口可以分页查询创建中、运行中、到期关停、退订关停、欠费关停、服务关闭等状态的实例列表。
2.此接口数据查询存在一定延迟,通常3-5秒左右,不适合时延敏感场景使用。
1.单账号QPS上限为5。
2.子用户使用该接口时,应具备BillingCenterFullAccess或BillingCenterReadOnlyAccess权限策略。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListAvailableInstances | 要执行的操作,取值:ListAvailableInstances。 |
Version | String | 是 | 2022-01-01 | API的版本,取值:2022-01-01。 |
InstanceIDs | Array of String | 否 | ["ins1","ins2"] | 实例id 列表,单次最多100 |
Product | String | 否 | ECS | 商品编号 |
RenewType | String | 否 | Manually | 续费类型(仅支持支持一个):自动续费、手动续费、到期不续费。 |
BeginTimeStart | String | 否 | 2019-05-06T08:05:01Z | 实例开始时间段起,UTC格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
BeginTimeEnd | String | 否 | 2019-05-06T08:05:01Z | 实例开始时间段止,UTC格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
ExpiredTimeStart | String | 否 | 2019-05-06T08:05:01Z | 实例到期时间段起,UTC格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
ExpiredTimeEnd | String | 否 | 2019-05-06T08:05:01Z | 实例到期时间段止,UTC格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
NextToken | String | 否 | 0 | 下一次查询的起始位(有效数字) |
MaxResults | Integer | 是 | 100 | 单次查询的页大小,范围支持[1,100] |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceList | Array of Object | [] | 实例列表 |
NextToken | String | 100 | 下一次查询的起始位 |
MaxResults | Integer | 10 | 查询的页大小 |
POST /?Action=ListAvailableInstances&Version=2022-01-01 HTTP/1.1 Host: billing.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20240731T042427Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240731/cn-beijing/billing/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "InstanceIDs": [ "[\"ins1\",\"ins2\"]" ], "Product": "xZCnwqn7z8", "RenewType": "Manually", "BeginTimeStart": "2019-05-06T08:05:01Z", "BeginTimeEnd": "2019-05-06T08:05:01Z", "ExpiredTimeStart": "2019-05-06T08:05:01Z", "ExpiredTimeEnd": "2019-05-06T08:05:01Z", "NextToken": "0", "MaxResults": 72 }
{ "ResponseMetadata": { "RequestId": "2024073112244021310502604481EB82", "Action": "ListAvailableInstances", "Version": "2022-01-01", "Service": "billing", "Region": "cn-beijing" }, "Result": { "InstanceList": [ { "InstanceID": "z", "AccountID": 405, "InstanceName": "kfKMdL", "Product": "mIKRNN6WRVi", "ConfigurationCode": "GmZRLHly", "PaymentMethod": "Pre", "Status": "ServiceShutdown", "SubStatus": "oarbm", "RenewType": "r51St3", "RenewalTimes": "tjXI6ssl", "RenewalDurationUnit": "6n", "RemainRenewTimes": "331Qp", "BeginTime": "2024-07-02T15:17:21+08:00", "ExpiredTime": "2024-07-02T15:17:21+08:00" } ], "NextToken": "41", "MaxResults": 10 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | MissingParameter | 参数缺失 |
400 | InvalidParam | 参数无效 |
403 | RequestReject | 您涉及违规操作,暂时无法使用该功能 |
404 | RecordNotFound | 记录未找到 |
429 | FrequentRequest | 操作频繁,请稍后尝试 |
500 | InternalError | 服务内部异常 |