DescribeInstanceAutoRenewalAttribute - 查詢執行個體是否開通自動續約 - Tair (Redis® OSS-Compatible)

查看雲資料庫 Tair（相容 Redis）執行個體是否開通自動續約。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeInstanceAutoRenewalAttribute

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元，且該參數值中不能包含非 ASCII 字元。	ETnLKlblzczshOTUbOCz****
RegionId	string	是	執行個體所屬的地區 ID。	cn-hangzhou
DBInstanceId	string	否	執行個體的 ID。說明預設查詢所有執行個體是否開通自動續約。	r-bp1zxszhcgatnx****
PageSize	integer	否	每頁記錄數，取值：30、50、100。說明預設值：30。	30
PageNumber	integer	否	頁碼，大於 0 且不超過 Integer 的最大值，預設值：1。	1

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	2B17D708-1D6D-49F3-B6D7-478371DD****
PageNumber	integer	當前顯示的頁碼。	1
PageRecordCount	integer	當前頁顯示的記錄數。	30
TotalRecordCount	integer	總記錄數。	1
Items	object
Item	array<object>	執行個體的自動續約資訊組成的集合。
	object
Duration	integer	續約周期，單位為月。	1
DBInstanceId	string	執行個體 ID。	r-bp1zxszhcgatnx****
AutoRenew	string	自動續約狀態，傳回值： true：已開啟。 false：未開啟。	true
RegionId	string	地區 ID。	cn-shanghai

樣本

正常返回樣本

JSON格式

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

異常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParameter	Specified parameter exceeds range.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。