DescribeAutoRenewAttribute - 查詢叢集自動續約狀態 -

查詢PolarDB訂用帳戶叢集自動續約狀態。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeAutoRenewAttribute

list

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。說明您可以通過介面 DescribeRegions 查看地區 ID 詳情。	cn-hangzhou
DBClusterIds	string	否	叢集 ID，支援傳入多個叢集 ID，多個叢集 ID 間用英文逗號（,）分隔。	pc-****************
PageSize	integer	否	每頁記錄數，取值範圍為 30、50、100，預設值為 30。	30
PageNumber	integer	否	頁碼。取值為大於 0 且不超過整數資料類型的最大值，預設值為 1。	1
ResourceGroupId	string	否	資源群組 ID。	rg-re*********
CloudProvider	string	否		ENS

返回參數

名稱	類型	描述	樣本值
	object
Items	object
AutoRenewAttribute	array<object>	叢集續約資訊列表。
	object
AutoRenewEnabled	boolean	是否開啟自動續約： true：開啟。 false：關閉。	true
DBClusterId	string	叢集 ID。	pc-*****************
Duration	integer	續約時間長度。	4
PeriodUnit	string	時間長度單位： Year：年。 Month：月。	Month
RegionId	string	地區 ID。	cn-hangzhou
RenewalStatus	string	續約狀態，取值範圍如下： AutoRenewal：自動續約。 Normal：手動續約，到期前簡訊提醒。 NotRenewal：到期不續約，到期前無提醒，只在到期前第三天發送不續約提醒。	AutoRenewal
PageNumber	integer	頁數。	1
PageRecordCount	integer	總頁數。	1
RequestId	string	請求 ID。	65D7ACE6-4A61-4B6E-B357-8CB24A******
TotalRecordCount	integer	總記錄數。	1

樣本

正常返回樣本

JSON格式

{
  "Items": {
    "AutoRenewAttribute": [
      {
        "AutoRenewEnabled": true,
        "DBClusterId": "pc-*****************",
        "Duration": 4,
        "PeriodUnit": "Month",
        "RegionId": "cn-hangzhou",
        "RenewalStatus": "AutoRenewal"
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 1,
  "RequestId": "65D7ACE6-4A61-4B6E-B357-8CB24A******",
  "TotalRecordCount": 1
}

異常返回樣本

JSON格式

{
	"Items": {
		"AutoRenewAttribute": [
			{
				"RenewalStatus": "AutoRenewal",
				"Duration": 1,
				"RegionId": "cn-hangzhou",
				"AutoRenewEnabled": true,
				"PeriodUnit": "Month",
				"DBClusterId": "pc-xxxxxxxxxxxxxxxx"
			}
		]
	},
	"TotalRecordCount": 1,
	"PageNumber": 1,
	"RequestId": "8ABD1FF2-85B1-4D03-8C99-FB603B8AF82D",
	"PageRecordCount": 1
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	指定的參數RegionId無效
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	指定的參數PageSize無效
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	指定的參數PageNumber無效
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	由於某些未知錯誤、異常或失敗，請求處理失敗。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	由於伺服器臨時故障，請求失敗。

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

變更歷史

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