ListProductQuotas - Quota Center - 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quotas:ListProductQuotas

list

*Quota

acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	次のクエリを開始するために使用されるトークンです。最初のクエリの場合、または後続のクエリが必要ない場合は、このパラメーターを空のままにします。後続のクエリが必要な場合は、最後の API 呼び出しから返された NextToken 値に値を設定します。	AAAAAd****
MaxResults	integer	任意	クエリに対して返されるレコードの最大数。有効値: 1～100。デフォルト値: 30。	30
ProductCode	string	必須	クラウド製品の略称です。説明クラウド製品の略称を取得する方法の詳細については、「ListProducts」の `ProductCode` パラメーターをご参照ください。	ecs
QuotaActionCode	string	任意	クォータ ID です。	q_security-groups
KeyWord	string	任意	クォータの検索に使用するキーワードです。説明このパラメーターは、Elastic Compute Service (ECS) のインスタンスタイプのクォータにのみ適用されます。検索は `QuotaName` と `QuotaActionCode` で実行されます。	security
SortField	string	任意	クォータのソートに使用するフィールドです。説明このパラメーターは、ECS のインスタンスタイプのクォータにのみ適用されます。このパラメーターを設定しない場合、クエリ結果はソートされません。列挙値: TOTAL : 合計クォータ使用量でソートします。 TIME : 最終更新時間でソートします。 RESERVED : 予約済みクォータ使用量でソートします。	TIME
SortOrder	string	任意	結果をソートする順序です。説明このパラメーターは、ECS のインスタンスタイプのクォータにのみ適用されます。このパラメーターを設定しない場合、クエリ結果はソートされません。列挙値: Descending : 降順でソートします。 Ascending : 昇順でソートします。	Ascending
Dimensions	array<object>	任意	クォータディメンションです。
	object	任意	クォータディメンションです。
Key	string	任意	クォータディメンションのキーです。説明 N の値は、クラウド製品でサポートされているディメンションの数によって異なります。	regionId
Value	string	任意	クォータディメンションの値です。説明 N の値は、クラウド製品でサポートされているディメンションの数によって異なります。	cn-hangzhou
QuotaCategory	string	任意	クォータのカテゴリです。デフォルト値: CommonQuota。列挙値: FlowControl : API レート制限クォータ WhiteListLabel : 権限クォータ CommonQuota : 一般クォータ	FlowControl
GroupCode	string	任意	ディメンショングループのコードです。	entconsole_w1j3ms****

レスポンスフィールド

フィールド	型	説明	例
	object	返された結果です。
MaxResults	integer	クエリに対して返されたレコードの最大数。	1
NextToken	string	次のクエリを開始するために使用されるトークンです。このパラメーターが空の場合、後続のクエリは開始されません。値が返された場合、その値は次のクエリに使用されるトークンです。	AAAAAd****
Quotas	array<object>	クォータの詳細です。
	array<object>	クォータの詳細です。
Adjustable	boolean	クォータが調整可能かどうかを示します。列挙値: true : クォータは調整可能です。 false : クォータは調整できません。	true
ApplicableRange	array	クォータに対してリクエストできるクォータ値の範囲。これは、クォータ増加リクエストのリファレンスとして使用できます。
	number	リクエストできるクォータ値の範囲です。この範囲には、ユーザーの既存のクォータは含まれません。クォータの増加をリクエストする際に、これをリファレンスとして使用できます。例: `[1010,10000]`。	[1010,10000]
ApplicableType	string	クォータ調整のタイプです。列挙値: continuous : クォータ値は連続しています。 discontinuous : クォータ値は不連続です。	discontinuous
ApplyReasonTips	string	クォータ増加リクエストの理由の例です。	The business xxx is expected to grow by 50%.
Consumable	boolean	使用済みクォータが表示されるかどうかを示します。列挙値: true : 使用済みクォータが表示されます。 false : 使用済みクォータは表示されません。	true
Dimensions	object	クォータディメンションです。フォーマット: `{"regionId":"Region"}`。	{"regionId":"cn-hangzhou"}
EffectiveTime	string	クォータが有効になる UTC 時間です。	2022-09-28T06:07:00Z
ExpireTime	string	クォータの有効期限が切れる UTC 時間です。	2022-09-29T06:07:00Z
GlobalQuota	boolean	クォータがグローバルクォータであるかどうかを示します。列挙値: true : クォータはすべてのリージョンで共有されます。 false : クォータは各リージョンで独立しています。	true
Period	object	クォータの計算サイクルです。
PeriodUnit	string	計算サイクルの単位です。列挙値: week : 週 hour : 時間 day : 日 second : 秒 minute : 分	day
PeriodValue	integer	計算サイクルの値です。	{}
ProductCode	string	クラウド製品の略称です。	ecs
QuotaActionCode	string	クォータ ID です。	q_security-groups
QuotaArn	string	クォータの Alibaba Cloud リソースネーム (ARN) です。	acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups
QuotaCategory	string	クォータのカテゴリです。列挙値: FlowControl : API レート制限クォータ WhiteListLabel : 権限クォータ CommonQuota : 一般クォータ	CommonQuota
QuotaDescription	string	クォータの説明です。	The maximum number of security groups that can be owned by the current account.
QuotaItems	array<object>	クォータの詳細です。
	object	クォータの詳細です。
Quota	string	クォータ値です。	1009
QuotaUnit	string	クォータの単位です。	Count
Type	string	クォータタイプです。列挙値: BaseQuota : 保証クォータ ReservedQuota : 予約済みクォータ	BaseQuota
Usage	string	クォータ使用量です。	1009
QuotaName	string	クォータの名前です。	ecs.g5.2xlarge
QuotaType	string	クォータタイプです。列挙値: normal : 標準 privilege : 権限	privilege
QuotaUnit	string	クォータの単位です。	AMOUNT
SupportedRange	array	クォータでサポートされているクォータ値の範囲。これは、クォータテンプレートを設定する際のリファレンスとして使用できます。
	number	クォータでサポートされているクォータ値の範囲。これは、クォータテンプレートを設定する際のリファレンスとして使用できます。 ApplicableType が continuous で、値が [1009,10000] の場合、1009 から 10000 までのすべての値がサポートされていることを示します。 ApplicableType が discontinuous で、値が [10,20,50,100] の場合、10、20、50、100 の値のみがサポートされていることを示します。	[1009,10000]
TotalQuota	number	クォータ値です。	200
TotalUsage	number	クォータ使用量です。	1009
UnadjustableDetail	string	クォータが調整できない理由です。列挙値: limitReached : クォータ制限に達しました。 nonactivated : サービスがアクティブ化されていません。 applicationProcess : クォータ増加リクエストが処理中です。	applicationProcess
UsageMetric	object	CloudMonitor のクォータ使用量のモニタリング情報です。説明空の値は、CloudMonitor でクォータのモニタリングデータが利用できないことを示します。
MetricDimensions	object	CloudMonitor のディメンションです。フォーマット: キーと値のペアのコレクション。例: `{"productCode":"*","metricKey":"","regionId":"","label":"*"}`。
	string	CloudMonitor のディメンションの値です。	ecs
MetricName	string	CloudMonitor メトリックの名前です。	Usage
MetricNamespace	string	CloudMonitor のメトリックの名前空間です。	acs_quotas_flowcontrol
RequestId	string	リクエスト ID です。	D0131FD5-5397-44FE-BF5A-4B7165B813CC
TotalCount	integer	リクエストに対して返されたレコードの総数です。	1

例

成功レスポンス

JSONJSON

{
  "MaxResults": 1,
  "NextToken": "AAAAAd****",
  "Quotas": [
    {
      "Adjustable": true,
      "ApplicableRange": [
        0
      ],
      "ApplicableType": "discontinuous",
      "ApplyReasonTips": "The business xxx is expected to grow by 50%.",
      "Consumable": true,
      "Dimensions": {
        "regionId": "cn-hangzhou"
      },
      "EffectiveTime": "2022-09-28T06:07:00Z",
      "ExpireTime": "2022-09-29T06:07:00Z",
      "GlobalQuota": true,
      "Period": {
        "PeriodUnit": "day",
        "PeriodValue": 0
      },
      "ProductCode": "ecs",
      "QuotaActionCode": "q_security-groups",
      "QuotaArn": "acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups",
      "QuotaCategory": "CommonQuota",
      "QuotaDescription": "The maximum number of security groups that can be owned by the current account.",
      "QuotaItems": [
        {
          "Quota": "1009",
          "QuotaUnit": "Count",
          "Type": "BaseQuota",
          "Usage": "1009"
        }
      ],
      "QuotaName": "ecs.g5.2xlarge",
      "QuotaType": "privilege",
      "QuotaUnit": "AMOUNT",
      "SupportedRange": [
        0
      ],
      "TotalQuota": 200,
      "TotalUsage": 1009,
      "UnadjustableDetail": "applicationProcess",
      "UsageMetric": {
        "MetricDimensions": {
          "key": "ecs"
        },
        "MetricName": "Usage",
        "MetricNamespace": "acs_quotas_flowcontrol"
      }
    }
  ],
  "RequestId": "D0131FD5-5397-44FE-BF5A-4B7165B813CC",
  "TotalCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidSortOrder	Invalid SortOrder
400	INVALID.MAX.RESULTS	The maxResults parameter is invalid. Use an integer ranging from 1 to 100.
400	DIMENSIONGROUP.NOT.FOUND	Dimension group does not exist.

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

変更履歴

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