DescribeInstanceAutoRenewalAttribute - - Alibaba Cloud Dokümantasyon Merkezi

Bir Tair (Redis OSS uyumlu) örneği için otomatik yenilemenin etkin olup olmadığını sorgular.

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

kvstore:DescribeInstanceAutoRenewalAttribute

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	İsteğin yinelenmezliğini sağlamak için kullanılan istemci belirteci. Değeri oluşturmak için istemciyi kullanabilirsiniz, ancak bu değerin farklı istekler arasında benzersiz olduğundan emin olmalısınız. Belirteç yalnızca ASCII karakterleri içerebilir ve uzunluğu 64 karakteri aşamaz.	ETnLKlblzczshOTUbOCz****
RegionId	string	Yes	Örneğin bölge kimliği.	cn-hangzhou
DBInstanceId	string	No	Örneğin kimliği. Not Varsayılan olarak sistem, tüm örnekler için otomatik yenilemenin etkin olup olmadığını kontrol eder.	r-bp1zxszhcgatnx****
PageSize	integer	No	Her sayfada döndürülecek giriş sayısı. Geçerli değerler: 30, 50 ve 100. Not Varsayılan değer: 30.	30
PageNumber	integer	No	Döndürülecek sayfanın sayfa numarası. Değer, 0 değerinden büyük bir tam sayı olmalıdır. Varsayılan değer: 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	İsteğin kimliği.	2B17D708-1D6D-49F3-B6D7-478371DD****
PageNumber	integer	Döndürülen sayfanın sayfa numarası.	1
PageRecordCount	integer	Geçerli sayfada döndürülen giriş sayısı.	30
TotalRecordCount	integer	Döndürülen toplam giriş sayısı.	1
Items	object
Item	array<object>	Örneğin otomatik yenileme bilgilerinin ayrıntıları.
	object
Duration	integer	Otomatik yenileme süresi. Birim: ay.	1
DBInstanceId	string	Örneğin kimliği.	r-bp1zxszhcgatnx****
AutoRenew	string	Otomatik yenilemenin etkin olup olmadığını gösterir. Geçerli değerler: true: Otomatik yenileme etkindir. false: Otomatik yenileme devre dışıdır.	true
RegionId	string	Örneğin bölge kimliği.	cn-shanghai

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParameter	Specified parameter exceeds range.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.