ListSites - 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:ListSites

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteName	string	任意	サイト名。クエリのフィルター条件として使用されます。
SiteSearchType	string	任意	サイト名の検索一致モード。デフォルトは完全に一致です。有効な値: prefix: プレフィックス一致。 suffix: サフィックス一致。 exact: 完全に一致。 fuzzy: あいまい一致。
PageNumber	integer	任意	ページングのページ番号。値は 1 以上である必要があります。
PageSize	integer	任意	ページングの 1 ページあたりのエントリ数。有効な値: 1～500。
TagFilter	array<object>	任意	タグフィルタールール。
	object	任意
Key	string	任意	タグキー。クエリのフィルター条件として使用されます。
Value	string	任意	タグ値。クエリのフィルター条件として使用されます。
ResourceGroupId	string	任意	リソースグループ ID。クエリのフィルター条件として使用されます。
Status	string	任意	サイトステータス。クエリのフィルター条件として使用されます。
OnlyEnterprise	boolean	任意	Enterprise Edition のサイトのみをクエリするかどうかを指定します。Enterprise Edition のサイトのみをクエリするには、このパラメーターを true に設定します。
PlanSubscribeType	string	任意	プランのサブスクリプションタイプ。有効な値: basicplan: Basic Edition。 standardplan: Standard Edition。 advancedplan: Premium Edition。 enterpriseplan: Enterprise Edition。
Coverage	string	任意	加速リージョン。有効な値: domestic: 中国本土のみ。 global: グローバル。 overseas: グローバル (中国本土を除く)。
AccessType	string	任意	アクセスタイプ。有効な値: NS: NS ベースのアクセス。 CNAME: CNAME ドメイン名ベースのアクセス。
OrderBy	string	任意	ソートフィールド。デフォルトでは、作成時間でソートされます。有効な値: gmtCreate: サイト作成時間。 visitTime: サイトアクセス時間。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。
PageNumber	integer	返されたデータのページ番号。
PageSize	integer	1 ページあたりに表示されるサイト数。
TotalCount	integer	サイトの総数。
Sites	array<object>	照会されたサイト情報のリスト。
	array<object>
AccessType	string	サイトのアクセスタイプ。有効な値: NS: NS ベースのアクセス。 CNAME: CNAME ドメイン名ベースのアクセス。
CnameZone	string	サイトの CNAME ドメイン名サフィックス。CNAME ドメイン名ベースのアクセスを使用するサイトの場合、レコードに設定する必要がある CNAME ドメイン名サフィックスです。
Coverage	string	サイトの加速リージョン。有効な値: domestic: 中国本土のみ。 global: グローバル。 overseas: グローバル (中国本土を除く)。
CreateTime	string	サイトの作成時間。時間は ISO 8601 形式で、協定世界時 (UTC) で表示されます。フォーマット: yyyy-MM-ddTHH:mm:ssZ。
UpdateTime	string	サイトの更新時間。時間は ISO 8601 形式で、協定世界時 (UTC) で表示されます。フォーマット: yyyy-MM-ddTHH:mm:ssZ。
InstanceId	string	サイトに関連付けられたプランのインスタンス ID。
NameServerList	string	サイトに割り当てられたネームサーバーのリスト。複数の値はカンマ (,) で区切られます。
PlanName	string	プラン名。
PlanSpecName	string	サイトプランのスペック名。
ResourceGroupId	string	リソースグループ ID。
SiteId	integer	サイト ID。
SiteName	string	サイト名。
Status	string	サイトステータス。有効な値: pending: サイトは構成待ちです。 active: サイトはアクティブな状態です。 offline: サイトはオフラインです。 moved: サイトは別のサイトに置き換えられました。
Tags	object	サイトタグ。
VerifyCode	string	サイト所有権の検証コード。サイトが CNAME ドメイン名ベースのアクセスを使用する場合、この TXT 検証コードを設定する必要があります。
VisitTime	string	サイトのアクセス時間。時間は ISO 8601 形式で、協定世界時 (UTC) で表示されます。フォーマット: yyyy-MM-ddTHH:mm:ssZ。
OfflineReason	string	サイトが無効化された理由。有効な値: expiration_ arrears: サブスクリプションプランが期限切れであるか、アカウントに支払い遅延があります。 internally_disabled: サイトはシステムによって無効化されました。 missing_icp: ドメイン名に ICP 登録がありません。 content_violation: コンテンツ違反。 proactively_disabled: ユーザーが自発的にサイトを無効化したか、設定した使用量上限に達したためサイトが無効化されました。

例

成功レスポンス

JSONJSON

{
  "RequestId": "",
  "PageNumber": 0,
  "PageSize": 0,
  "TotalCount": 0,
  "Sites": [
    {
      "AccessType": "",
      "CnameZone": "",
      "Coverage": "",
      "CreateTime": "",
      "UpdateTime": "",
      "InstanceId": "",
      "NameServerList": "",
      "PlanName": "",
      "PlanSpecName": "",
      "ResourceGroupId": "",
      "SiteId": 0,
      "SiteName": "",
      "Status": "",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "VerifyCode": "",
      "VisitTime": "",
      "OfflineReason": ""
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InternalException	Failed to call the service. Try again later or contact technical support.

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

変更履歴

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