GetSite - Edge Security Acceleration - Alibaba Cloud ドキュメントセンター

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

get

*Site

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイトの ID。この ID を取得するには、ListSites 操作を呼び出します。	1234567890123

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	9732E117-8A37-49FD-A36F-ABBB87556CA7
SiteModel	object	サイトの詳細。
AccessType	string	サイトのアクセスタイプ。有効な値： NS：NS 経由のアクセス。 CNAME：CNAME 経由のアクセス。	NS
CnameZone	string	CNAME 経由で追加されたサイトの場合、このサフィックスを使用して CNAME レコードを設定します。	example.cname.com
Coverage	string	加速リージョン。有効な値： domestic：中国本土のみ global：グローバル overseas：グローバル (中国本土を除く)	domestic
CreateTime	string	サイトが作成された時刻 (協定世界時 (UTC))。ISO 8601 形式 (`yyyy-MM-ddTHH:mm:ssZ`) です。	2023-12-24T02:01:11Z
UpdateTime	string	サイトが最後に更新された時刻 (協定世界時 (UTC))。ISO 8601 形式 (`yyyy-MM-ddTHH:mm:ssZ`) です。	2023-12-24T02:01:11Z
InstanceId	string	プランインスタンスの ID。	cas-merge-q6h0bv
NameServerList	string	サイトに割り当てられたネームサーバーのカンマ区切りリスト。	male1-1.ialicdn.com,female1-1.ialicdn.com
PlanName	string	プランの名前。	plan-168777532****
PlanSpecName	string	プラン仕様の名前。	normal
ResourceGroupId	string	リソースグループの ID。	rg-aek26g6i6se****
SiteId	integer	サイトの ID。	1234567890123
SiteName	string	サイトの名前。	example.com
Status	string	サイトのステータス。有効な値： pending：サイトは設定待ちです。 active：サイトはアクティブです。 offline：サイトはオフラインです。 moved：サイトは置き換えられました。	pending
Tags	object	サイトのタグ。	{"tag1":"value1"}
VerifyCode	string	CNAME 経由で追加されたサイトの場合、このコードを TXT レコードとして設定する必要があります。	verify_d516cb3740f81f0cef77d162edd1****
VanityNSList	object	各キーはカスタムネームサーバーで、その値はサーバーの IP アドレスのカンマ区切りリストです。
	string	カスタムネームサーバーの名前。	ns1.example.com
VersionManagement	boolean	`true` の場合、サイトのバージョン管理が有効になります。	true
OfflineReason	string	サイトがオフラインである理由。このパラメーターは、`Status` が `offline` の場合にのみ表示されます。有効な値： expiration_arrears：サブスクリプションプランの有効期限が切れているか、アカウントに支払い遅延があります。 internally_disabled：サイトはシステムによって無効化されました。 missing_icp：ドメインに ICP ライセンスがありません。 content_violation：サイトがコンテンツポリシーに違反しました。 proactively_disabled：サイトは、ユーザーまたはユーザーが設定した使用量制限によって無効化されました。	expiration_ arrears

例

成功レスポンス

JSONJSON

{
  "RequestId": "9732E117-8A37-49FD-A36F-ABBB87556CA7",
  "SiteModel": {
    "AccessType": "NS",
    "CnameZone": "example.cname.com",
    "Coverage": "domestic",
    "CreateTime": "2023-12-24T02:01:11Z",
    "UpdateTime": "2023-12-24T02:01:11Z",
    "InstanceId": "cas-merge-q6h0bv",
    "NameServerList": "male1-1.ialicdn.com,female1-1.ialicdn.com",
    "PlanName": "plan-168777532****",
    "PlanSpecName": "normal",
    "ResourceGroupId": "rg-aek26g6i6se****",
    "SiteId": 1234567890123,
    "SiteName": "example.com",
    "Status": "pending",
    "Tags": {
      "tag1": "value1"
    },
    "VerifyCode": "verify_d516cb3740f81f0cef77d162edd1****",
    "VanityNSList": {
      "key": "ns1.example.com"
    },
    "VersionManagement": true,
    "OfflineReason": "expiration_ arrears"
  }
}

エラーコード

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

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

変更履歴

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