调用DescribeInstanceAutoRenewalAttribute接口查询MongoDB实例是否为自动付费。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeInstanceAutoRenewalAttribute

系统规定参数。取值：DescribeInstanceAutoRenewalAttribute。

RegionId String 是 cn-hangzhou

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

DBInstanceId String 否 dds-bp567b****

实例ID。
DBInstanceType String 否 replicate

实例类型。取值：

  • replicate（默认值）：单节点或副本集实例。
  • sharding：分片集群实例。
PageSize Long 否 30

每页记录数。取值：30（默认值）、50或100。

PageNumber Long 否 1

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

返回数据

名称 类型 示例值 描述
ItemsNumbers Integer 2

查询结果总数。
PageRecordCount Integer 2

当前页显示的记录数。
RequestId String FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949

请求ID。
PageNumber Integer 1

页码。
Items Array of Item

查询结果列表。
Item
DBInstanceType String replicate

实例类型，返回值为：

  • replicate：单节点或副本集实例。
  • sharding：分片集群实例。
AutoRenew String true

自动续费状态，返回值为：

  • true：已开启自动续费。
  • false：未开启自动续费。
Duration String 1

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

说明
DbInstanceId String dds-bp2568*****

实例ID。
RegionId String cn-hangzhou

地域ID。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeInstanceAutoRenewalAttribute
&RegionId=cn-hangzhou
&DBInstanceId=dds-bp567b****
&DBInstanceType=replicate
&PageSize=30
&PageNumber=1
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeInstanceAutoRenewalAttributeResponse>
	<Items>
		<Item>
			<DBInstanceType>replicate</DBInstanceType>
			<RegionId>cn-hangzhou</RegionId>
			<DbInstanceId>dds-bpxxxxxxxx</DbInstanceId>
			<AutoRenew>false</AutoRenew>
		</Item>
		<Item>
			<DBInstanceType>replicate</DBInstanceType>
			<Duration>1</Duration>
			<RegionId>cn-hangzhou</RegionId>
			<DbInstanceId>dds-bpxxxxxxxx</DbInstanceId>
			<AutoRenew>true</AutoRenew>
		</Item>
	</Items>
	<PageNumber>1</PageNumber>
	<RequestId>FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949</RequestId>
	<ItemsNumbers>2</ItemsNumbers>
	<PageRecordCount>2</PageRecordCount>
</DescribeInstanceAutoRenewalAttributeResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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