文档

QueryAvailableInstances - 实例查询服务

更新时间:
一键部署

查询用户可用实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bss:DescribeInstancesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Regionstring

地域。

cn-hangzhou
PageNuminteger

页码。

1
PageSizeinteger

每页条数,默认值为 20,最大不超过 300 个。

20
ProductCodestring

产品代码。可通过接口 QueryProductList 查询产品代码。

说明 当设置了 region 时,不为空。
rds
ProductTypestring

产品类型。

rds
SubscriptionTypestring

订阅类型。

  • Subscription:预付费。
  • PayAsYouGo:后付费。
Subscription
InstanceIDsstring

实例 ID。多个 ID 用英文逗号分隔,最大不超过 100 个。

rm-xxxxxxxxxxxx
EndTimeStartstring

结束时间段起,符合 ISO8601 标准的 utc 时间格式,例如 2016-05-23T12:00:00Z。

2016-05-23T12:00:00Z
EndTimeEndstring

结束时间段止,符合 ISO8601 标准的 utc 时间格式,例如 2016-05-23T12:00:00Z。

2016-05-23T12:00:00Z
CreateTimeStartstring

创建时间段起,符合 ISO8601 标准的 utc 时间格式。

2016-05-23T12:00:00Z
CreateTimeEndstring

创建时间段止,符合 ISO8601 标准的 utc 时间格式。

2016-05-23T12:00:00Z
RenewStatusstring

续费状态,取值:

  • AutoRenewal:自动续费。
  • ManualRenewal:手动续费。
  • NotRenewal:不续费。
AutoRenewal

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful!
RequestIdstring

请求 ID。

C7C15585-8349-4C62-BEE4-5A391841B9BE
Successboolean

是否成功。

true
Dataobject

返回数据。

PageNuminteger

页码。

1
PageSizeinteger

每页条数。

10
TotalCountinteger

总记录数。

11
InstanceListobject []

实例信息的列表。

SubStatusstring

子状态。

Normal-后付费模块正常 WaitForLimit-后付费模块即将欠费受限 BandwidthLimited-后付费模块欠费受限
Statusstring

状态。

Creating-资源创建中 WaitForExpire-即将停服 Normal-正常 Expired-停服
ExpectedReleaseTimestring

期望释放时间。

2019-09-08T16:00:00Z
RenewStatusstring

续费状态,取值:

  • AutoRenewal:自动续费。
  • ManualRenewal:手动续费。
  • NotRenewal:不续费。
ManualRenewal
CreateTimestring

创建时间。

2019-09-08T16:00:00Z
SellerIdlong

卖方 ID。

123123123
InstanceIDstring

实例 ID。

1049056
Sellerstring

卖方。

123123123
StopTimestring

停止时间。

2019-09-08T16:00:00Z
RenewalDurationUnitstring

自动续费周期单位,取值:

  • M:月。
  • Y:年。
M
SubscriptionTypestring

订阅类型,取值:

  • Subscription:预付费。
  • PayAsYouGo:后付费。
Subscription
OwnerIdlong

所有者 ID。

325352345
EndTimestring

结束时间。

2019-09-08T16:00:00Z
ProductTypestring

产品类型。

rds
Regionstring

地域。

cn-hangzhou
ReleaseTimestring

释放时间。

2019-09-08T16:00:00Z
RenewalDurationinteger

自动续费周期数量。

1
ProductCodestring

产品代码。

rds

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "C7C15585-8349-4C62-BEE4-5A391841B9BE",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 11,
    "InstanceList": [
      {
        "SubStatus": "Normal-后付费模块正常\nWaitForLimit-后付费模块即将欠费受限\nBandwidthLimited-后付费模块欠费受限",
        "Status": "Creating-资源创建中\nWaitForExpire-即将停服\nNormal-正常\nExpired-停服",
        "ExpectedReleaseTime": "2019-09-08T16:00:00Z",
        "RenewStatus": "ManualRenewal",
        "CreateTime": "2019-09-08T16:00:00Z",
        "SellerId": 123123123,
        "InstanceID": "1049056",
        "Seller": "123123123",
        "StopTime": "2019-09-08T16:00:00Z",
        "RenewalDurationUnit": "M",
        "SubscriptionType": "Subscription",
        "OwnerId": 325352345,
        "EndTime": "2019-09-08T16:00:00Z",
        "ProductType": "rds",
        "Region": "cn-hangzhou",
        "ReleaseTime": "2019-09-08T16:00:00Z",
        "RenewalDuration": 1,
        "ProductCode": "rds"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史