DescribeInstanceAutoRenewalAttribute - ApsaraDB for MongoDB

You can call this operation to query whether auto-renewal is enabled for an ApsaraDB for MongoDB instance.

Operation description

This operation is applicable to subscription instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeInstanceAutoRenewalAttribute

get

Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.	cn-hangzhou
DBInstanceId	string	No	The ID of the instance.	dds-bp567b****
DBInstanceType	string	No	The category of the instance. Valid values: replicate: the standalone or replica set instance sharding: the sharded cluster instance Default value: replicate.	replicate
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, and 100. Note Default value: 30.	30
PageNumber	integer	No	The number of the page to return. The value must be a positive integer that does not exceed the maximum value of the Integer parameter. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
ItemsNumbers	integer	The total number of entries returned.	2
PageRecordCount	integer	The number of entries that were returned on the current page.	2
RequestId	string	The ID of the request.	FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949
PageNumber	integer	The page number of the returned page.	1
Items	object
Item	array<object>	Details about returned entries.
	object
DBInstanceType	string	The category of the instance. Valid values: replicate: the standalone or replica set instance sharding: the sharded cluster instance	replicate
AutoRenew	string	Indicates whether auto-renewal is enabled for the instance. Valid values: true: Auto-renewal is enabled for the instance. false: Auto-renewal is disabled for the instance.	true
Duration	string	The auto-renewal period. Unit: months. Note This parameter is ruturned only when the returned value of the AutoRenew parameter is true. You can call the ModifyInstanceAutoRenewalAttribute operation to modify the auto-renewal period.	1
DbInstanceId	string	The ID of the instance.	dds-bp2568*****
RegionId	string	The region ID of the instance.	cn-hangzhou

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error response

JSON format

{
 "Items": {
   "Item": [
     {
       "Duration": 1,
       "RegionId": "cn-shanghai",
       "DBInstanceId": "r-xxxxxxxxxxxxxxx",
       "AutoRenew": "true"
     }
   ]
 },
 "TotalRecordCount": 1,
 "PageNumber": 1,
 "RequestId": "2B17D708-1D6D-49F3-B6D7-478371DDDBE8",
 "PageRecordCount": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error occurred. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.