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

弾力性保証のステータス、マッチングモード、発効方式、有効期限、使用済みインスタンス数などの詳細を取得します。

今すぐお試しください

この 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:DescribeElasticityAssurances

get

*ElasticityAssurance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Elasticity Assurance が存在するリージョンの ID です。DescribeRegions API を呼び出して、最新の Alibaba Cloud リージョンリストをクエリできます。	cn-hangzhou
ResourceGroupId	string	任意	リソースグループの ID です。このパラメーターを使用してリソースをフィルタリングする場合、一致するリソースの数は 1,000 を超えることはできません。説明デフォルトリソースグループによるフィルタリングはサポートされていません。	rg-bp67acfmxazb4p****
Tag	array<object>	任意	Elasticity Assurance をフィルタリングするためのタグです。
	object	任意	キーと値のペアで構成されるタグです。
Key	string	任意	タグキーです。リソースをフィルタリングするために、最大 20 個のタグキーを指定できます。指定されたタグに一致するリソースが最大 1,000 個返されます。1,000 を超えるリソースがタグに一致する場合は、ListTagResources API を呼び出してすべてのリソースをクエリしてください。	TestKey
Value	string	任意	タグ値です。最大 20 個のタグ値を指定できます。	TestValue
MaxResults	integer	任意	ページごとに返される最大エントリ数です。最大値：100。デフォルト値：10。	10
NextToken	string	任意	次のリクエストで新しい結果ページを取得するために使用するページネーショントークンです。最初のリクエストではこのパラメーターを指定する必要はありません。前回のクエリから取得したトークンを NextToken の値として指定する必要があります。	caeba0bbb2be03f84eb48b699f0a4883
PrivatePoolOptions.Ids	string	任意	Elasticity Assurance の ID です。最大 100 個の Elasticity Assurance ID を JSON 配列で指定できます。	["eap-bp67acfmxazb4**", "eap-bp67acfmxazb5**"]
Platform	string	任意	説明このパラメーターは非推奨です。	null
InstanceType	string	任意	インスタンスタイプです。このパラメーターは、アクティブな Elasticity Assurance のみをクエリするために使用できます。リリース済みの Elasticity Assurance をクエリするには、`PrivatePoolOptions.Ids` を使用する必要があります。	ecs.c6.large
ZoneId	string	任意	Elasticity Assurance が存在するゾーンの ID です。	cn-hangzhou-h
InstanceChargeType	string	任意	インスタンスの課金方法です。 `PostPaid` (従量課金) のみがサポートされています。デフォルト値： `PostPaid`。	PostPaid
Status	string	任意	Elasticity Assurance のステータスです。有効な値： `All`：すべてのステータス。 `Deactivated`：Elasticity Assurance はアクティブ化待ちです。このステータスは招待プレビューでのみ利用可能です。 `Preparing`：Elasticity Assurance は準備中です。 `Prepared`：Elasticity Assurance は準備完了です。 `Active`：Elasticity Assurance はアクティブです。 `Released`：Elasticity Assurance はリリース済みです。このパラメーターを指定しない場合、`Released` ステータスを除くすべての Elasticity Assurance が返されます。	Active
PackageType	string	任意	Elasticity Assurance のパッケージタイプです。有効な値： `ElasticityAssurance`：標準 Elasticity Assurance。このタイプの Elasticity Assurance は、`RecurrenceRules` を指定しない場合に作成されます。 `TimeDivisionElasticityAssurance`：時間分割 Elasticity Assurance。このタイプの Elasticity Assurance は、`RecurrenceRules` を指定した場合に作成されます。	ElasticityAssurance

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次の結果ページを取得するためのトークンです。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	リクエスト ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	一致するエントリの総数です。	1
MaxResults	integer	ページあたりのエントリ数です。	10
ElasticityAssuranceSet	object
ElasticityAssuranceItem	array<object>	弾力性保証の詳細です。
	array<object>	弾力性保証の詳細です。
Status	string	弾力性保証のステータスです。有効な値： Preparing：弾力性保証を準備中です。 Prepared：弾力性保証は準備完了です。 Active：弾力性保証はアクティブです。 Released：弾力性保証は解放済みです。	Active
PrivatePoolOptionsMatchCriteria	string	弾力性保証のマッチングモードです。有効な値： Open：オープンモードです。弾力性保証はインスタンス起動リクエストに自動的にマッチします。一致するプライベートプールを利用できない場合、システムはパブリックプールのリソースを使用します。 Target：ターゲットモードです。インスタンスは、指定したプライベートプールのキャパシティを使用して起動されます。プライベートプールを利用できない場合、インスタンスの起動に失敗します。	Target
PrivatePoolOptionsId	string	弾力性保証の ID です。	eap-bp1ir35kqtn8ywci****
UsedAssuranceTimes	integer	説明このパラメーターは現在使用されていません。	0
LatestStartTime	string	説明このパラメーターは現在使用されていません。	null
PrivatePoolOptionsName	string	弾力性保証の名前です。	eapTestName
RegionId	string	弾力性保証が属するリージョンの ID です。	cn-hangzhou
EndTime	string	弾力性保証の有効期限が切れる時刻です。	2021-12-03T16:00Z
StartTime	string	弾力性保証が発効する時刻です。	2020-12-03T05:25Z
Description	string	弾力性保証の説明です。	This is description.
ResourceGroupId	string	リソースグループの ID です。	rg-bp67acfmxazb4p****
TotalAssuranceTimes	string	弾力性保証を使用できる回数です。この値は常に `Unlimited` であり、有効期間内で無制限に使用できることを示します。	Unlimited
AllocatedResources	object
AllocatedResource	array<object>	割り当て済みリソースの詳細です。
	array<object>	割り当て済みリソースの詳細です。
UsedAmount	integer	使用中のインスタンス数です。	2
TotalAmount	integer	このインスタンスタイプのリザーブドインスタンスの総数です。	2
AvailableAmount	integer	説明このパラメーターは現在使用されていません。	5
FailedAmount	integer		1
LockedAmount	integer		1
zoneId	string	弾力性保証が属するゾーンの ID です。	cn-hangzhou-h
InstanceType	string	インスタンスタイプです。	ecs.c6.large
ElasticityAssuranceUsages	object
ElasticityAssuranceUsage	array<object>	説明このパラメーターは現在使用されていません。
	object	説明このパラメーターは現在使用されていません。
AccountId	string	説明このパラメーターは現在使用されていません。	1144775968548340
ServiceName	string	説明このパラメーターは現在使用されていません。	name
UsedAmount	integer	説明このパラメーターは現在使用されていません。	1
Tags	object
Tag	array<object>	弾力性保証に付与されたタグです。
	object	弾力性保証に付与されたタグの詳細です。
TagValue	string	タグ値です。	TestValue
TagKey	string	タグキーです。	TestKey
InstanceChargeType	string	インスタンスの支払い方法です。従量課金のみがサポートされています。値は常に `PostPaid` です。	PostPaid
StartTimeType	string	弾力性保証が発効するタイミングです。有効な値： `Now`：弾力性保証は作成後すぐに発効します。 `Later`：弾力性保証は `StartTime` で指定した時刻に発効します。	Now
ElasticityAssuranceOwnerId	string	説明このパラメーターは現在使用されていません。	e114477596854834
RecurrenceRules	object
RecurrenceRule	array<object>	時間分割弾力性保証の繰り返しルールです。
	object	時間分割弾力性保証の繰り返しルールです。
RecurrenceType	string	繰り返しタイプです。有効な値： `Daily`：毎日繰り返します。 `Weekly`：毎週繰り返します。 `Monthly`：毎月繰り返します。	Daily
RecurrenceValue	string	繰り返しルールの値です。このパラメーターの有効な値は、`RecurrenceType` の値によって異なります。 `RecurrenceType` が `Daily` の場合、このパラメーターには 1～31 の単一の値を指定できます。この値は、日単位の繰り返し間隔を表します。 `RecurrenceType` が `Weekly` の場合、このパラメーターには 0～6 の複数の値をカンマ区切りで指定できます。値は日曜日から土曜日に対応します。たとえば、`1,2` は、ルールが月曜日と火曜日に適用されることを示します。 `RecurrenceType` が `Monthly` の場合、このパラメーターには `A-B` 形式の範囲を指定できます。A と B の値は 1～31 で、B は A 以上である必要があります。たとえば、`1-5` は、ルールが毎月 1 日から 5 日まで適用されることを示します。	1
StartHour	integer	時間分割弾力性保証のアクティブ期間の開始時刻 (時) です。	4
EndHour	integer	時間分割弾力性保証のアクティブ期間の終了時刻 (時) です。	10
PackageType	string	弾力性保証のタイプです。有効な値： `ElasticityAssurance`：標準の弾力性保証です。 `TimeDivisionElasticityAssurance`：時間分割弾力性保証です。	ElasticityAssurance

例

成功レスポンス

JSONJSON

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 10,
  "ElasticityAssuranceSet": {
    "ElasticityAssuranceItem": [
      {
        "Status": "Active",
        "PrivatePoolOptionsMatchCriteria": "Target",
        "PrivatePoolOptionsId": "eap-bp1ir35kqtn8ywci****",
        "UsedAssuranceTimes": 0,
        "LatestStartTime": "null",
        "PrivatePoolOptionsName": "eapTestName",
        "RegionId": "cn-hangzhou",
        "EndTime": "2021-12-03T16:00Z",
        "StartTime": "2020-12-03T05:25Z",
        "Description": "This is description.",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "TotalAssuranceTimes": "Unlimited",
        "AllocatedResources": {
          "AllocatedResource": [
            {
              "UsedAmount": 2,
              "TotalAmount": 2,
              "AvailableAmount": 5,
              "FailedAmount": 1,
              "LockedAmount": 1,
              "zoneId": "cn-hangzhou-h",
              "InstanceType": "ecs.c6.large",
              "ElasticityAssuranceUsages": {
                "ElasticityAssuranceUsage": [
                  {
                    "AccountId": "1144775968548340",
                    "ServiceName": "name",
                    "UsedAmount": 1
                  }
                ]
              }
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "InstanceChargeType": "PostPaid",
        "StartTimeType": "Now",
        "ElasticityAssuranceOwnerId": "e114477596854834",
        "RecurrenceRules": {
          "RecurrenceRule": [
            {
              "RecurrenceType": "Daily",
              "RecurrenceValue": "1",
              "StartHour": 4,
              "EndHour": 10
            }
          ]
        },
        "PackageType": "ElasticityAssurance"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter.RegionId	The specified RegionId should not be null.
400	InvalidParameter.Name	The specified PrivatePoolOptions.Name is invalid.
400	InvalidParameter.PrivatePoolOptions.Ids	The specified PrivatePoolOptions.Ids is invalid.
400	DedicatedHostNotSupported	DedicatedHost is not supported for PrivatePool.
400	SpotNotSupported	Spot is not supported for PrivatePool.
400	ClassicNetworkNotSupported	Classic network is not supported for PrivatePool.
400	Invalid.InstanceId	Instance does not exist.
400	Invalid.PrivatePoolOptions.MatchCriteria	Target mode does not support this operation.
400	MissingParameter.PrivatePoolOptions.Id	The specified PrivatePoolOptions.Id should not be null.
400	Invalid.PrivatePoolOptions.Id	The PrivatePool does not exist.
400	Invalid.InstanceType	The InstanceType does not match the PrivatePool.
400	Invalid.InstanceChargeType	The InstanceChargeType does not match the PrivatePool.
400	Invalid.ZoneId	The ZoneId does not match the PrivatePool.
400	Invalid.PrivatePoolOptions.status	The PrivatePool has been used up.
400	InvalidPlatform.ValueNotSupported	The Platform does not match the PrivatePool.
400	InvalidAliUid	The PrivatePool does not belong to the user of the Instance.
400	MissingParameter.PackageType	The specified parameter "PackageType" can not be empty.
400	MissingParameter.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" can not be empty.
400	MissingParameter.InstanceCpuCoreCount	The specified parameter "InstanceCpuCoreCount" can not be empty.
400	MissingParameter.InstanceAmount	The specified parameter "InstanceAmount" can not be empty.
400	MissingParameter.InstanceCpuCoreCountOrInstanceAmount	The specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time.
400	Invalid.TooManyPrivatePoolOptions.Ids	Too many PrivatePoolOptions.Ids in this request.
400	Invalid.TooManyZoneIds	Too many ZoneIds in the request.
400	Invalid.TooManyInstanceTypes	Too many InstanceTypes in the request.
400	Invalid.TooManyUnpaidPrivatePool	Too many PrivatePools create but still unpaid.
400	Invalid.InstanceCpuCoreCountOrInstanceAmount	Both InstanceCpuCoreCount and InstanceAmount are provided.
400	Invalid.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" exist invalid element Id.
400	Invalid.PackageType	The specified parameter "PackageType" is invalid.
400	Invalid.PrivatePool.Purchase	The PrivatePool has already paid.
400	Invalid.AssuranceTimes.NotSupported	The value of AssuranceTimes is not supported.
400	RepeatStartPrivatePool	PrivatePool has already been started.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	InvalidResourceGroup.NotFound	The specified resource group is not found.

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

変更履歴

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