API による ESA プランクォータと使用量のクエリ - Edge Security Acceleration

サイトまたはプラン ID を基に、プラン内のクォータおよび実際の使用量を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:ListInstanceQuotasWithUsage

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	プラン ID。これは、ListSites 操作を呼び出すことで取得できます。	sp-xcdn-96wblslz****
SiteId	integer	任意	サイト ID。これは、ListSites 操作を呼び出すことで取得できます。	1232223****
QuotaNames	string	必須	プラン内のクォータ名です。複数のクォータ名をカンマ (,) で区切って指定します。1 回の照会で最大 10 個のクォータ名を指定できます。有効な値は以下のとおりです。 customHttpCert：カスタム証明書 transition_rule：変換ルール waiting_room：ウェイティングルーム https\|rule_quota：SSL/TLS ルール cache_rules\|rule_quota：キャッシュルール configuration_rules\|rule_quota：構成ルール redirect_rules\|rule_quota：リダイレクトルール compression_rules\|rule_quota：圧縮ルール origin_rules\|rule_quota：オリジンルール	customHttpCert

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	85H66C7B-671A-4297-9187-2C4477247A74
InstanceId	string	プラン ID。	sp-xcdn-96wblslz****
Status	string	プランのステータス。有効な値は以下のとおりです。 online：サービス中 offline：許容期間内に期限切れとなった状態。この状態では、プランは利用できません。 disable：プランがリリースされた状態	online
Quotas	array<object>	プラン内のクォータおよびその実際の使用量。
	array<object>	プラン内のクォータおよびクォータ使用量の詳細情報。
QuotaName	string	クォータ名。	redirect_rules\|rule_quota
QuotaValue	string	クォータ値。	10
Usage	string	クォータ使用量。	3
SiteUsage	array<object>	プランに関連付けられた各サイトにおけるクォータの使用量。
	object	単一のサイトにおけるクォータ使用量の詳細情報。
SiteId	integer	サイト ID。	34818329392****
SiteUsage	string	サイトにおけるクォータ使用量。	1
SiteName	string	サイト名。	test.top

例

成功レスポンス

JSONJSON

{
  "RequestId": "85H66C7B-671A-4297-9187-2C4477247A74",
  "InstanceId": "sp-xcdn-96wblslz****",
  "Status": "online",
  "Quotas": [
    {
      "QuotaName": "redirect_rules|rule_quota",
      "QuotaValue": "10",
      "Usage": "3",
      "SiteUsage": [
        {
          "SiteId": 0,
          "SiteUsage": "1",
          "SiteName": "test.top"
        }
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter	The specified parameter is invalid.
400	QuotaNotExist	The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400	NoPermission	You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user.
400	ErService.HasOpened	You have already activated Edge Routine.
403	Site.NotExist	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.
404	SiteNotFound	The website does not exist or does not belong to you.
404	UnsupportQuota	Unsupported quota is specified. Check and try again.

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

変更履歴

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