文档

DescribeInstanceAutoRenewalAttribute - 查询MongoDB实例是否为自动付费

更新时间:

查询MongoDB实例是否为自动付费。

接口说明

说明 本接口适用于包年包月付费类型的实例。

调试

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

调试

授权信息

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

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

请求参数

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

实例所属的地域 ID。您可以通过调用 DescribeDBInstanceAttribute 接口查询。

cn-hangzhou
DBInstanceIdstring

实例 ID。

dds-bp567b****
DBInstanceTypestring

实例类型。取值:

  • replicate(默认值):单节点或副本集实例。
  • sharding:分片集群实例。
replicate
PageSizelong

每页记录数。取值:30(默认值)、50100

30
PageNumberlong

页码,取值为大于 0 且不超过 Integer 数据类型的最大值,默认值为 1

1

返回参数

名称类型描述示例值
object
ItemsNumbersinteger

查询结果总数。

2
PageRecordCountinteger

当前页显示的记录数。

2
RequestIdstring

请求 ID。

FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949
PageNumberinteger

页码。

1
Itemsobject []

查询结果列表。

DBInstanceTypestring

实例类型,返回值为:

  • replicate:单节点或副本集实例。
  • sharding:分片集群实例。
replicate
AutoRenewstring

自动续费状态,返回值为:

  • true:已开启自动续费。
  • false:未开启自动续费。
true
Durationstring

自动续费的续费周期,单位为月。

说明
  • AutoRenew 参数的返回值为 true 时,才会返回本参数。
  • 您可以调用 ModifyInstanceAutoRenewalAttribute 接口,修改自动续费的周期。
  • 1
    DbInstanceIdstring

    实例 ID。

    dds-bp2568*****
    RegionIdstring

    地域 ID。

    cn-hangzhou

    示例

    正常返回示例

    JSON格式

    {
      "ItemsNumbers": 2,
      "PageRecordCount": 2,
      "RequestId": "FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949",
      "PageNumber": 1,
      "Items": {
        "Item": [
          {
            "DBInstanceType": "replicate",
            "AutoRenew": "true",
            "Duration": "1",
            "DbInstanceId": "dds-bp2568*****",
            "RegionId": "cn-hangzhou"
          }
        ]
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    400InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误,请稍后重试。

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    文档反馈