DescribeAutoSnapshotPolicyEx - Elastic Compute Service

本介面用於查詢指定地域下已建立的自動快照策略詳細資訊列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeAutoSnapshotPolicyEx

get

AutoSnapshotPolicy

acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/*

AutoSnapshotPolicy

acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/{#snapshotpolicyId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	要查詢的自動快照策略所在的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。	cn-hangzhou
AutoSnapshotPolicyId	string	否	自動快照策略 ID。	sp-bp67acfmxazb4ph****
AutoSnapshotPolicyName	string	否	自動快照策略的名稱。長度為 2~128 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文和數字等）。可以包含半形冒號（:）、底線（_）、半形句號（.）或者短劃線（-）。	TestName
PageNumber	integer	否	自動快照策略返回結果分多頁展示。起始值：1。預設值：1。	1
PageSize	integer	否	分頁展示返回的自動快照策略時的每頁行數。最大值：100。預設值：10。	10
Tag	array<object>	否	標籤列表。
	object	否	標籤資訊。
Key	string	否	自動快照策略的標籤鍵。N 的取值範圍：1~20。一旦傳入該值，則不允許為空字串。最多支援 128 個字元，不能以 aliyun 和 acs: 開頭，不能包含 http:// 或者 https://。	TestKey
Value	string	否	自動快照策略的標籤值。N 的取值範圍：1~20。一旦傳入該值，可以為空字串。最多支援 128 個字元，不能包含 http:// 或者 https://。	TestValue
ResourceGroupId	string	否	資源群組 ID。使用該參數過濾資源時，資源數量不能超過 1000 個。說明不支援預設資源群組過濾。	rg-aek2kkmhmhs****

返回參數

名稱	類型	描述	樣本值
	object
PageSize	integer	分頁展示返回的自動快照策略時的每頁行數。	10
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	自動快照策略列表的頁碼。	1
TotalCount	integer	自動快照策略的總個數。	1
AutoSnapshotPolicies	object
AutoSnapshotPolicy	array<object>	自動快照策略詳情集合。
	array<object>	自動快照策略詳情。
TimePoints	string	指定自動快照的建立時間點。使用 UTC +8 時間，單位為小時。從 00:00~23:00 共 24 個時間點可選，參數為 0~23 的數字，如：1 代表在 01:00 時間點。可以選定多個時間點。傳遞參數為 JSON 數組格式：`["0", "1", ... "23"]`，最多 24 個時間點，用半形逗號字元（,）隔開。	["1"]
CreationTime	string	建立時間。按照ISO 8601標準表示，並需要使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。	2019-12-10T16:00Z
Status	string	自動快照策略狀態。可能值： Normal：正常。 Expire：由於帳號欠費無法使用該策略。	Normal
AutoSnapshotPolicyName	string	自動快照策略的名稱。	testAutoSnapshotPolicyName
TargetCopyRegions	string	說明該參數正在邀測中，暫未開放使用。	test
CopiedSnapshotsRetentionDays	integer	說明該參數正在邀測中，暫未開放使用。	0
AutoSnapshotPolicyId	string	自動快照策略 ID。	sp-bp67acfmxazb4ph****
RetentionDays	integer	指定自動快照的保留時間，單位為天。可能值： -1：永久儲存。 1~65536：指定儲存天數。	7
RegionId	string	自動快照策略所屬的地區 ID。	cn-hangzhou
DiskNums	integer	啟用該策略的雲端硬碟數量。	1
EnableCrossRegionCopy	boolean	說明該參數正在邀測中，暫未開放使用。	false
RepeatWeekdays	string	指定自動快照的重複日期。選定周一到周日中需要建立快照的日期，參數為 1~7 的數字，如 1 表示周一。允許選擇多個日期。	["6"]
VolumeNums	integer	啟用該策略的拓展卷數量。	2
ResourceGroupId	string	資源群組 ID。	rg-aek2kkmhmhs****
Tags	object
Tag	array<object>	自動快照策略的標籤索引值集合。
	object	自動快照策略的標籤索引值集合。
TagValue	string	自動快照策略的標籤值。	TestValue
TagKey	string	自動快照策略的標籤鍵。	TestKey
CopyEncryptionConfiguration	object	快照跨地區複製加密參數對象。
Encrypted	boolean	是否開啟快照跨地區加密複製。取值範圍： true：是。 false：否。預設值：false。	false
KMSKeyId	string	快照跨地區加密複製使用的 KMS 金鑰識別碼。	0e478b7a-4262-4802-b8cb-00d3fb40****
Type	string	自動快照策略類型。 Custom：使用者定義的快照策略。 System：系統定義的快照策略。	Custom

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "AutoSnapshotPolicies": {
    "AutoSnapshotPolicy": [
      {
        "TimePoints": "[\"1\"]",
        "CreationTime": "2019-12-10T16:00Z",
        "Status": "Normal",
        "AutoSnapshotPolicyName": "testAutoSnapshotPolicyName",
        "TargetCopyRegions": "test",
        "CopiedSnapshotsRetentionDays": 0,
        "AutoSnapshotPolicyId": "sp-bp67acfmxazb4ph****",
        "RetentionDays": 7,
        "RegionId": "cn-hangzhou",
        "DiskNums": 1,
        "EnableCrossRegionCopy": false,
        "RepeatWeekdays": "[\"6\"]",
        "VolumeNums": 2,
        "ResourceGroupId": "rg-aek2kkmhmhs****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "CopyEncryptionConfiguration": {
          "Encrypted": false,
          "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
        },
        "Type": "Custom"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidRegionId.NotFound	The specified RegionId does not exist.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.
400	InvalidTagCount	The specified tags are beyond the permitted range.

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

變更歷史

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