DescribeActivations - Elastic Compute Service

呼叫 DescribeActivations 查詢已建立的啟用碼以及啟用碼的使用情況。

介面說明

支援以下兩種方式檢視返回資料：

方式一：分頁查詢首頁時，僅需設定 MaxResults 以限制返回資訊的條目數，返回結果中的 NextToken 將作為查詢後續頁的憑證。查詢後續頁時，將 NextToken 參數設定為上一次返回結果中獲取到的 NextToken 作為查詢憑證，並設定 MaxResults 限制返回條目數。
方式二：透過 PageSize 設定單頁返回的條目數，再透過 PageNumber 設定頁碼。以上兩種方式只能任選其中之一。如果設定了 MaxResults 或 NextToken 參數，則請求參數 PageSize 和 PageNumber 將失效，且返回資料中的 TotalCount 無效。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeActivations

get

Activation

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

Activation

acs:ecs:{#regionId}:{#accountId}:activation/{#activationId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地域 ID。目前支援的地域：華北 1（青島）、華北 2（北京）、華北 3（張家口）、華北 5（呼和浩特）、華北 6（烏蘭察布）、華東 1（杭州）、華東 2（上海）、華南 1（深圳）、華南 2（河源）、華南 3（廣州）、西南 1（成都）、中國香港、新加坡、日本（東京）、美國（矽谷）、美國（維吉尼亞）。您可以呼叫 DescribeRegions 檢視地域對應的 ID 等資訊。	cn-hangzhou
ActivationId	string	否	啟用碼 ID。	4ECEEE12-56F1-4FBC-9AB1-890F1234****
InstanceName	string	否	預設的執行個體名稱首碼。	test-InstanceName
PageNumber	integer	否	目前頁碼。起始值為 1。預設值為 1。	1
PageSize	integer	否	分頁查詢時設定的每頁列數。最大值為 50。預設值為 10。	10
MaxResults	integer	否	分頁查詢時每頁的最大條目數。最大值為 50。預設值為 10。	10
NextToken	string	否	查詢憑證（Token），取值為上一次 API 呼叫返回的 NextToken 參數值。	AAAAAdDWBF2****
ResourceGroupId	string	否	啟用碼所屬的資源群組 ID。	rg-123******
Tag	array<object>	否	標籤清單。
	object	否	標籤清單。
Key	string	否	託管執行個體啟用碼的標籤鍵。N 的取值範圍為 1~20。一旦傳入該值，則不允許為空字串。使用一個標籤篩選資源，查詢到該標籤下的資源數量不能超過 1000 個；使用多個標籤篩選資源，查詢到同時綁定了多個標籤的資源數量不能超過 1000 個。如果資源數量超過 1000 個，您需要使用 ListTagResources 介面進行查詢。最多支援 64 個字元，不能以 `aliyun` 或 `acs:` 開頭，不能包含 `http://` 或 `https://`。	TestKey
Value	string	否	託管執行個體啟用碼的標籤值。N 的取值範圍為 1~20。該值可以為空字串。最多支援 128 個字元，不能包含 `http://` 或 `https://`。	TestValue

返回參數

名稱	類型	描述	樣本值
	object
ActivationList	array<object>	啟用碼及使用情況資訊組成的集合。
	array<object>
ActivationId	string	啟用碼 ID。	4ECEEE12-56F1-4FBC-9AB1-890F1234****
CreationTime	string	建立時間。格式為 ISO 8601，時區為 UTC。	2021-01-20T06:00:00Z
DeregisteredCount	integer	已註銷的執行個體數。	1
Description	string	啟用碼對應的描述。	This is description.
Disabled	boolean	啟用碼是否被停用。	false
InstanceCount	integer	啟用碼用於註冊託管執行個體的使用次數上限。	1
InstanceName	string	預設的執行個體名稱首碼。	test-InstanceName
IpAddressRange	string	允許使用該啟用碼的主機 IP。	0.0.0.0/0
RegisteredCount	integer	已註冊的執行個體數。	1
ResourceGroupId	string	啟用碼所屬的資源群組 ID。	rg-123******
Tags	array<object>	託管執行個體啟用碼的標籤資訊。
	object	託管執行個體啟用碼的標籤資訊。
TagKey	string	託管執行個體啟用碼的標籤鍵。	owner
TagValue	string	託管執行個體啟用碼的標籤值。	zhangsan
TimeToLiveInHours	integer	啟用碼的有效時間。單位：小時。	4
NextToken	string	本次呼叫返回的查詢憑證值。	AAAAAdDWBF2****
PageNumber	integer	目前頁碼。	1
PageSize	integer	分頁查詢時設定的每頁列數。	10
RequestId	string	請求 ID。	4ECEEE12-56F1-4FBC-9AB1-890F74625134
TotalCount	integer	符合查詢條件的記錄筆數。	1

樣本

正常返回樣本

JSON格式

{
  "ActivationList": [
    {
      "ActivationId": "4ECEEE12-56F1-4FBC-9AB1-890F1234****",
      "CreationTime": "2021-01-20T06:00:00Z",
      "DeregisteredCount": 1,
      "Description": "This is description.",
      "Disabled": false,
      "InstanceCount": 1,
      "InstanceName": "test-InstanceName",
      "IpAddressRange": "0.0.0.0/0",
      "RegisteredCount": 1,
      "ResourceGroupId": "rg-123******",
      "Tags": [
        {
          "TagKey": "owner",
          "TagValue": "zhangsan"
        }
      ],
      "TimeToLiveInHours": 4
    }
  ],
  "NextToken": "AAAAAdDWBF2****",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "4ECEEE12-56F1-4FBC-9AB1-890F74625134",
  "TotalCount": 1
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	RegionId.ApiNotSupported	The api is not supported in this region.	指定區域下不支援呼叫 API。請檢查 RegionId 參數取值是否正確。
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	指定的標籤鍵參數有誤。
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	指定的標籤值參數有誤。
400	NumberExceed.Tags	The Tags parameter number is exceed.	標籤個數超過最大限制，本操作最多可以操作 20 個標籤。
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	標籤中存在重複的鍵，請保持鍵的唯一性。
400	MissingParameter.TagKey	You must specify Tag.N.Key.	請指定標籤鍵。
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	指定的參數MaxResults不合法。
500	InternalError.Dispatch	An error occurred when you dispatched the request.	傳送請求時發生錯誤，請稍後重試。
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	該操作是不被允許的。
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	指定的 RegionId 不存在，請您檢查此產品在該地域是否可用。

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

變更歷史

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