すべてのプロダクト
Search
ドキュメントセンター

:BatchSetCdnDomainConfig

最終更新日:Mar 24, 2026

BatchSetCdnDomainConfig を呼び出して、ドメイン名にバッチ構成を適用します。

操作説明

  • ユーザーあたりのリクエストレートは 1 秒あたり 3 リクエストに制限されています。

  • 単一のリクエストで最大 50 のドメイン名を設定できます。複数のドメイン名はカンマで区切ります。

  • ドメイン名の機能を構成するために BatchSetCdnDomainConfig を呼び出すと、システムが一意の ConfigId を生成します。この ConfigId を使用して、構成を更新または削除できます。詳細については、「ConfigId の使用とクエリ」をご参照ください。

今すぐお試しください

この 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:BatchSetCdnDomainConfig

update

*Domain

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

なし
  • ram:CreateServiceLinkedRole

リクエストパラメーター

パラメーター

必須 / 任意

説明

DomainNames

string

必須

設定する高速化ドメイン名。複数のドメイン名はカンマで区切ります。以下の制限に注意してください。

  • 単一のリクエストで最大 20 のドメイン名を指定できます。

  • ドメイン名の数と関数の数を掛けた値は 50 を超えることはできません。

www.example.com

Functions

string

必須

関数構成の配列を含む、JSON 形式の文字列です。1 回のリクエストで最大 50 個の構成を指定できます。各構成オブジェクトには、以下のフィールドが含まれます:

  • functionName(文字列、必須):関数の名称です。設定可能な関数の一覧については、「関数一覧」をご参照ください。

  • argName(文字列、必須):functionName で指定した関数のパラメーター名です。複数のパラメーターを指定できます。

  • argValue(文字列、必須):argName で指定したパラメーターの値です。

  • parentId(long、任意):ルール条件(Rule Condition)の ID です。condition 関数を設定することでルールエンジン(Rule Engine)として機能するルール条件を作成します。ルール条件は、ユーザーのリクエストに含まれる各種パラメーターを識別し、それらに基づいてリクエストをマッチおよびフィルター処理します。詳細については、「ドメイン設定機能」をご参照ください。ルール条件を作成すると、一意の configId が生成されます。この configId を他の関数の parentId として指定することで、当該ルール条件を参照可能となり、より柔軟な構成が可能になります。

parentId-1 に設定すると、既存のルール条件との関連付けが解除されます。

   "functionArgs": [{
     "argName": "Parameter A", 
     "argValue": "Value for Parameter A"
    }, 
  {
    "argName": "Parameter B", 
    "argValue": "Value for Parameter B"
     }], 
 "functionName": "Function Name",
 "parentId": "<config_id>"
}]

parentId を使用しない構成の例: 以下の例では、origin_request_header 関数を使用してオリジン側の 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 を使用する構成の例: オリジン側の 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
}]

既存の origin_request_header 構成から、ルール条件 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": -1
}]

[{"functionArgs": [{"argName": "key","argValue": "Content-Encoding"},{"argName": "value","argValue": "gzip"}],"functionName": "set_resp_header"} ]

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

04F0F334-1335-436C-A1D7-6C044FE73368

DomainConfigList

object

DomainConfigModel

array<object>

ドメイン構成のリスト。

object

ConfigId

integer

構成 ID。値が 0 の場合、構成が失敗したことを示します。再適用する必要があります。

1234567

DomainName

string

ドメイン名。

www.example.com

FunctionName

string

関数名。

set_resp_header

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "DomainConfigList": {
    "DomainConfigModel": [
      {
        "ConfigId": 1234567,
        "DomainName": "www.example.com",
        "FunctionName": "set_resp_header"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidFunctions.Malformed The specified Functions is incorrectly formatted. 書式設定エラー。
400 InvalidArgValue.Malformed The specified ArgValue is invalid. 指定されたArgValueが不正です。
400 Invalid%s.ValueNotSupported [%s] is not supported.
400 Invalid%s.Malformed The specified ArgValue [%s] is invalid.
400 MissingParameter%s The specified value of ArgName[%s] is missing.
400 InvalidFunctionArgs.Malformed The specified FunctionArgs is invalid.
400 MissingParameter The specified ArgValue is missing.
400 InvalidHeaderKey.ValueNotSupported The specified value of parameter HeaderKey is not supported.
400 TooManyDomains The count of domain is over 50.
400 InvalidRule.Malformed %s
400 ConfigurationConflicts The staging environment has a configuration in effect and cannot modify the production environment configuration.
400 InvalidFunction.NotSupported The domain is not supported to set the function.
400 InvalidDomain.BelongToConfigGroup This Domain activated in configuration group and should modify by config group.
400 EntityNotExist.Role EntityNotExist.Role
400 MissingParameterFunctions The specified value of Functions is missing.
400 NoPermission.SLR The current user does not have permission to create servicelinkedrole. Please contact the Alibaba Cloud account or administrator to authorize AliyunCDNFullAccess or custom policy:Service Name:cdn-ddos.cdn.aliyuncs.com,Role: AliyunServiceRoleForCDNAccessingDDoS,Permission: ram: CreateServiceLinkedRole
400 ConfigExceedLimit Count of config entries exceeds the limit.
400 EdgeScriptCountExceedLimit The number of rules exceeds the default limit.
400 EdgeScripOptionsHasInnerConfig The extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.
400 EdgeScriptGrammarNotSupport A background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.
400 EdgeScriptNotSupportJs JavaScript rules are not supported. For more information, submit a ticket.
400 ServiceInvokeFailed Failed to invoke service.
400 ConfigParentExceedLimit Config parent exceed limit.
400 Function.InvalidParentId The specified parentId does not exist.
400 BatchSetBusinessError some configs error:%s
400 ConfigDuplicate Duplicate configuration. This function has already been configured and cannot be added repeatedly.
400 FunctionArgError The function parameter of the domain configuration is incorrect.

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

変更履歴

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