作成されたアクティベーションコードとその使用量を照会します。
操作説明
操作の説明
以下のいずれかのメソッドを使用して、返されるデータのビューを確認できます。
メソッド 1: ページングクエリの最初のページをクエリする場合、返されるエントリ数を制限するために MaxResults をセットするだけで済みます。応答内の NextToken 値は、次のページをクエリするためのトークンとして使用されます。次のページをページングクエリする場合、NextToken パラメーターを前の応答から取得した NextToken 値にセットし、返されるエントリ数を制限するために MaxResults をセットします。
メソッド 2: 各ページで返すエントリ数を指定するために PageSize をセットし、ページ番号を指定するために PageNumber をセットします。前述のメソッドのうち、使用できるのは 1 つだけです。MaxResults または NextToken パラメーターをセットした場合、PageSize および PageNumber リクエストパラメーターは無効になり、応答内の TotalCount 値も無効です。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeActivations |
get |
Activation
Activation
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。サポートされているリージョン:中国 (青島)、中国 (北京)、中国 (張家口)、中国 (フフホト)、中国 (ウランチャブ)、中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (河源)、中国 (広州)、中国 (成都)、中国 (香港)、シンガポール、日本 (東京)、米国 (シリコンバレー)、米国 (バージニア) です。 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 |
任意 |
クエリトークン。前の API 呼び出しから返された NextToken 値に設定します。 |
AAAAAdDWBF2**** |
| ResourceGroupId |
string |
任意 |
アクティベーションコードが属するリソースグループの ID。 |
rg-123****** |
| Tag |
array<object> |
任意 |
タグのリスト。 |
|
|
object |
任意 |
タグのリスト。 |
||
| Key |
string |
任意 |
ホストインスタンスのアクティベーションコード (動的コード) のタグキー。N の有効な値:1~20。タグキーは空の文字列にできません。 単一のタグを使用してリソースをフィルター処理する場合、そのタグの配下のリソース数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルター処理する場合、複数のタグにアタッチされているリソースのリソース数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合、 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 |
条件付きクエリ条件を満たすレコードの総数。 説明
MaxResults パラメーターと NextToken パラメーターを使用してページングクエリでページングを実行する場合、返される TotalCount 値に意味はありません。 |
1 |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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 が存在しません。指定されたリージョンでこのプロダクトが利用可能かどうかを確認してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。