DescribeActivations - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

既存のアクティベーションコードとその使用状況を照会します。

操作説明

注意事項

以下のいずれかの方法で応答を確認できます。

方法 1：ページングクエリ中に、`DescribeActivations` 操作を呼び出して結果の最初のページを取得する場合、`MaxResults` を使用して呼び出しで返す最大エントリ数を指定します。`NextToken` の戻り値はページネーショントークンであり、次のリクエストで新しいページの結果を取得するために使用できます。`DescribeActivations` 操作を呼び出して新しいページの結果を取得する場合、`NextToken` を前の呼び出しで返された `NextToken` 値に設定し、`MaxResults` を設定してこの呼び出しで返す最大エントリ数を指定します。
方法 2：`PageSize` を使用して各ページで返すエントリ数を指定し、次に `PageNumber` を使用して返すページの番号を指定します。上記の方法のいずれか 1 つのみを使用できます。`MaxResults` または `NextToken` を指定した場合、`PageSize` および `PageNumber` リクエストパラメーターは有効にならず、`TotalCount` レスポンスパラメーターは無効になります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeActivations

get

Activation

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

Activation

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。サポートされているリージョン：中国 (青島)、中国 (北京)、中国 (張家口)、中国 (フフホト)、中国 (ウランチャブ)、中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (河源)、中国 (広州)、中国 (成都)、中国 (香港)、シンガポール、日本 (東京)、米国 (シリコンバレー)、および米国 (バージニア)。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
RegionId	string	必須	リージョン ID。サポートされているリージョン：中国 (青島)、中国 (北京)、中国 (張家口)、中国 (フフホト)、中国 (ウランチャブ)、中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (河源)、中国 (広州)、中国 (成都)、中国 (香港)、シンガポール、日本 (東京)、米国 (シリコンバレー)、および米国 (バージニア)。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
ActivationId	string	任意	アクティベーションコードの ID。	4ECEEE12-56F1-4FBC-9AB1-890F1234****
InstanceName	string	任意	デフォルトのインスタンス名のプレフィックス。	test-InstanceName
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	ページあたりのエントリ数。有効値：1～50。デフォルト値：10。	10
MaxResults	integer	任意	ページあたりの最大エントリ数。有効値：1～50。デフォルト値：10。	10
NextToken	string	任意	次のリクエストで新しいページの結果を取得するために使用されるページネーショントークン。前のクエリから取得したトークンを NextToken の値として指定する必要があります。	AAAAAdDWBF2****
ResourceGroupId	string	任意	アクティベーションコードが属するリソースグループの ID。	rg-123******
Tag	array<object>	任意	アクティベーションコードのタグ。
	object	任意	アクティベーションコードのタグ。
Key	string	任意	アクティベーションコードのタグ N のキー。N の有効値：1～20。タグキーは空の文字列にできません。単一のタグを指定してリソースを照会する場合、このタグを持つ最大 1,000 個のリソースを返すことができます。複数のタグを指定してリソースを照会する場合、これらのすべてのタグを持つ最大 1,000 個のリソースを返すことができます。指定されたタグを持つ 1,000 個を超えるリソースを照会するには、ListTagResources 操作を呼び出します。タグキーは最大 64 文字で、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。	TestKey
Value	string	任意	アクティベーションコードのタグ N の値。N の有効値：1～20。タグ値は空の文字列にできます。タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。	TestValue

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	4ECEEE12-56F1-4FBC-9AB1-890F74625134
PageNumber	integer	ページ番号。	1
TotalCount	integer	返されたエントリの総数。	1
NextToken	string	ページネーショントークン。次のリクエストで新しいページの結果を取得するために使用できます。	AAAAAdDWBF2****
ActivationList	array<object>	アクティベーションコードとその使用状況。
	array<object>
CreationTime	string	アクティベーションコードが作成された時刻。	2021-01-20T06:00:00Z
DeregisteredCount	integer	登録解除されたインスタンスの数。	1
InstanceCount	integer	アクティベーションコードを使用してホストインスタンスを登録できる最大回数。	1
Description	string	アクティベーションコードの説明。	This is description.
RegisteredCount	integer	登録されたインスタンスの数。	1
InstanceName	string	デフォルトのインスタンス名のプレフィックス。	test-InstanceName
Disabled	boolean	アクティベーションコードが無効になっているかどうかを示します。	false
IpAddressRange	string	アクティベーションコードの使用を許可されているホストの IP アドレス。	0.0.0.0/0
TimeToLiveInHours	integer	アクティベーションコードの有効期間。単位：時間。	4
ActivationId	string	アクティベーションコードの ID。	4ECEEE12-56F1-4FBC-9AB1-890F1234****
ResourceGroupId	string	アクティベーションコードが属するリソースグループの ID。	rg-123******
Tags	array<object>	アクティベーションコードのタグ。
	object	アクティベーションコードのタグ。
TagKey	string	アクティベーションコードのタグキー。	owner
TagValue	string	アクティベーションコードのタグ値。	zhangsan

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	RegionId.ApiNotSupported	The api is not supported in this region.
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.
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.
500	InternalError.Dispatch	An error occurred when you dispatched the request.
403	Operation.Forbidden	The operation is not permitted.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。