ステージング環境の構成を照会します。一度に複数の特徴の構成を照会できます。
操作説明
各ユーザーがこの操作を呼び出すことができる回数は、1 秒あたり最大値 30 回です。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cdn:DescribeCdnDomainStagingConfig |
get |
*Domain
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DomainName |
string |
必須 |
アクセラレーションドメイン名。各リクエストで指定できるドメイン名は 1 つだけです。 |
example.com |
| FunctionNames |
string |
任意 |
カンマ (,) で区切られた特徴名のリスト。設定可能な特徴については、「特徴リスト」をご参照ください。指定した特徴リストが空の場合、応答では空の構成が返されます。 |
aliauth |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| DomainName |
string |
アクセラレーションドメイン名。 |
example.com |
| RequestId |
string |
リクエスト ID。 |
C80705BF-0F76-41FA-BAD1-5B59296A4E59 |
| DomainConfigs |
array<object> |
ドメイン名の構成。 |
|
|
array<object> |
|||
| Status |
string |
構成のステータス。有効な値:
|
success |
| ParentId |
string |
ルール条件の ID。これはオプションのパラメーターです。「ドメイン構成特徴パラメーター」で condition 関数 (ルールエンジン) を設定することで、ルール条件を作成できます。ルール条件は、リクエストに含まれるさまざまなパラメーターを識別して、ユーザーのリクエストをマッチングおよびフィルター処理できます。ルール条件が作成されると、対応する ConfigId が生成されます。この ConfigId は ParentId パラメーターとして使用し、他の関数から参照できます。これにより、ルール条件と特徴の構成を組み合わせて、より柔軟な構成のフォームを実現できます。 具体的な構成操作については、「ドメイン名の一括構成」または以下の ParentId の構成例をご参照ください。 |
222728944812032 |
| ConfigId |
string |
構成の ID。 |
6xx5 |
| FunctionName |
string |
特徴名。 |
aliauth |
| FunctionArgs |
array<object> |
各特徴の説明。 |
|
|
object |
|||
| ArgName |
string |
構成名。 |
auth_type |
| ArgValue |
string |
構成値。 |
req_auth |
ParentId の構成例
parentId に -1 を設定すると、構成内の既存のルール条件が削除されます。
[{
"functionArgs": [{
"argName": "功能参数 A",
"argValue": "功能参数 A 对应的值"
},
{
"argName": "功能参数 B",
"argValue": "功能参数 B 对应的值"
}],
"functionName": "功能名称",
"parentId": "选填项,对应引用规则条件的 configid"
}]
以下は、parentId を使用しない構成の例です。
origin_request_header 関数を使用して、configid=222728944812032 のルール条件を参照する back-to-origin 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 関数を使用して、configid=222728944812032 のルール条件を参照する back-to-origin 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": "222728944812032"
}]
例
成功レスポンス
JSONJSON
{
"DomainName": "example.com",
"RequestId": "C80705BF-0F76-41FA-BAD1-5B59296A4E59",
"DomainConfigs": [
{
"Status": "success",
"ParentId": "222728944812032",
"ConfigId": "6xx5",
"FunctionName": "aliauth",
"FunctionArgs": [
{
"ArgName": "auth_type",
"ArgValue": "req_auth"
}
]
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Invalid%s.ValueNotSupported | FunctionName [%s] is not supported. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。