GetApiSchemaUsage - Edge Security Acceleration - 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:GetApiSchemaUsage

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	任意	サイト ID。この ID は、ListSites 操作を呼び出すことで取得できます。	1159101787****
SiteVersion	integer	任意	サイトのバージョン。	0

レスポンスフィールド

フィールド	型	説明	例
	object	リクエストに対して返されるデータ。
RequestId	string	リクエスト ID。	952ea16b-1f05-4a76-bb32-420282d8****
InstanceId	string	プランのインスタンス ID。	esa-site-agknce3n****
InstanceUsage	integer	プランインスタンスにアップロードされた API スキーマファイルの総数。	10
Usages	array<object>	各サイトの使用状況の詳細。
	object	個々のサイトの使用状況の詳細。
Usage	integer	このサイトにアップロードされた API スキーマファイルの数。	0
Id	integer	サイト ID。	40000449
Name	string	サイト名。	test

例

成功レスポンス

JSONJSON

{
  "RequestId": "952ea16b-1f05-4a76-bb32-420282d8****",
  "InstanceId": "esa-site-agknce3n****",
  "InstanceUsage": 10,
  "Usages": [
    {
      "Usage": 0,
      "Id": 40000449,
      "Name": "test"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter.ApiShield.Quota	This website does not have the permission to view API security features.
400	SiteVersion.NotExist	The specified version is invalid or version management is not enabled for your website.Make sure that you specify a valid version and version management is enabled. Then, try again.

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

変更履歴

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