DescribeCdnDomainConfigs - - Alibaba Cloud ドキュメントセンター

DescribeCdnDomainConfigs 操作を呼び出して、高速化ドメイン名の構成を取得できます。 1 回の呼び出しで複数の機能の構成をクエリできます。

操作説明

説明

シングルユーザーのスロットリング制限は 1 秒あたり 100 回の呼び出しです。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cdn:DescribeCdnDomainConfigs

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
DomainName	string	必須	高速化ドメイン名。一度にクエリできるドメイン名は 1 つだけです。	example.com
FunctionNames	string	任意	機能の名前。複数の機能名はカンマ (,) で区切ります。機能名の詳細については、ドメイン名構成のパラメーターをご参照ください。	aliauth
ConfigId	string	任意	機能構成の ID。 ConfigId のクエリ方法と使用方法の詳細については、ConfigId の使用方法をご参照ください。	6295

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object
RequestId	string	リクエストの ID。	C80705BF-0F76-41FA-BAD1-5B59296A4E59
DomainConfigs	object
DomainConfig	array<object>	ドメイン名構成。
	object
Status	string	構成のステータス。有効な値： success: 構成は成功です。 testing: 構成はテスト中です。 failed: 構成は失敗しました。 configuring: 構成は進行中です。	success
ParentId	string	ルール条件の ID。このパラメーターはオプションです。ドメイン名構成のパラメーターで condition 機能 (ルールエンジン) を構成することで、ルール条件を作成できます。ルール条件は、リクエスト内のさまざまなパラメーターを検出することで、ユーザーリクエストを照合およびフィルタリングできます。ルール条件が作成されると、対応する ConfigId が生成されます。 ConfigId は、他の機能で ParentId パラメーターとして参照できます。このようにして、ルール条件と機能構成を組み合わせて、より柔軟な構成を作成できます。構成手順の詳細については、ドメイン名をバッチで構成する、またはこのトピックの ParentId 構成例をご参照ください。	222728944812032
ConfigId	string	構成 ID。	6295
FunctionName	string	機能の名前。	aliauth
FunctionArgs	object
FunctionArg	array<object>	各機能のパラメーター設定。
	object
ArgName	string	パラメーター名。これは functionName の構成項目です。複数の構成項目を構成できます。	auth_type
ArgValue	string	パラメーター値。これは functionName の構成項目の値です。	req_auth

ParentId 構成例

parentId が -1 に設定されている場合、構成内の既存のルール条件は削除されます。

   "functionArgs": [{
     "argName": "Feature parameter A", 
     "argValue": "Value of feature parameter A"  // 機能パラメーター A の値
    }, 
  {
    "argName": "Feature parameter B", 
    "argValue": "Value of feature parameter B"  // 機能パラメーター B の値
     }], 
 "functionName": "Feature name", // 機能名
 "parentId": "Optional. The configid of the referenced rule condition." // オプション。参照されるルール条件の configid。
}]

次の例は、origin_request_header 機能を使用して、parentId を使用せずにオリジンフェッチ HTTP リクエストヘッダーを追加する方法を示しています。リクエストパラメーターは次のとおりです。

        "functionArgs": [{
            "argName": "header_operation_type",
            "argValue": "add"
        }, {
            "argName": "header_name",
            "argValue": "Accept-Encoding"
        }, {
            "argName": "header_value",
            "argValue": "gzip"
        }, {
            "argName": "duplicate",
            "argValue": "off"
        }],
        "functionName": "origin_request_header"
}]

次の例は、parentId を使用する構成を示しています。この例では、origin_request_header 機能を使用して、オリジンフェッチ HTTP リクエストヘッダーを追加し、configid が 222728944812032 のルール条件を参照しています。リクエストパラメーターは次のとおりです。

        "functionArgs": [{
            "argName": "header_operation_type",
            "argValue": "add"
        }, {
            "argName": "header_name",
            "argValue": "Accept-Encoding"
        }, {
            "argName": "header_value",
            "argValue": "gzip"
        }, {
            "argName": "duplicate",
            "argValue": "off"
        }],
        "functionName": "origin_request_header",
        "parentId": "222728944812032"
}]

例

成功レスポンス

JSONJSON

{
  "RequestId": "C80705BF-0F76-41FA-BAD1-5B59296A4E59",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ParentId": "222728944812032",
        "ConfigId": "6295",
        "FunctionName": "aliauth",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "auth_type",
              "ArgValue": "req_auth"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.

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

変更履歴

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