All Products
Search
Document Center

CDN:SetCdnDomainStagingConfig

Last Updated:Nov 29, 2024

Configures a domain name to be accelerated in the staging environment.

Operation description

Note You can call this operation up to 30 times per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cdn:SetCdnDomainStagingConfigupdate
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify only one domain name.

example.com
FunctionsstringYes

The features that you want to configure. Format:

Note
  • functionName: The name of the feature. Separate multiple values with commas (,). For more information, see A list of features.
  • argName: The feature parameters for functionName.
  • argValue: The parameter values set for functionName.
  •     [
         {
           "functionArgs": [
            {
             "argName": "Parameter A", 
             "argValue": "Value of Parameter A"
            }, 
          {
            "argName": "Parameter B", 
            "argValue": "Value of Parameter B"
             }
         ], 
         "functionName": "Feature name"
            }
        ]
    
    [{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"xxx"}],"functionName":"edge_function"}]

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    04F0F334-1335-436C-A1D7-6C044FE73368
    DomainConfigListarray<object>

    The list of domain configurations.

    DomainConfigModelobject
    ConfigIdlong

    The ID of the configuration.

    1234567
    DomainNamestring

    The domain name.

    www.example.com
    FunctionNamestring

    The name of the feature.

    set_resp_header

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidFunctionName.ValueNotSupported%s-
    400InvalidArgValue.Malformed%s-
    400ConfigurationConflictsThe staging environment has a configuration in effect and cannot modify the production environment configuration.Failed to modify the parameter settings in the production environment because the parameter settings are different from those in the stating environment. Set parameters in the staging environment before you publish them to the production environment.
    400InvalidArgName.ValueNotSupported%s-
    400GrayConfigExistThe domain exists other gray config.The staging environment already contains settings for the domain name.
    400InvalidRule.Malformed%s-
    400InvalidDomain.BelongToConfigGroupThis Domain activated in configuration group and should modify by config group.-
    400EdgeScriptCountExceedLimitThe number of rules exceeds the default limit (1). To increase the limit, submit a ticket.-
    400EdgeScripOptionsHasInnerConfigThe extension has a background configuration or a parameter of this configuration is invalid. For more information, submit a ticket.The extension has a background configuration or a configured parameter is invalid. For more information, submit a ticket.
    400EdgeScriptGrammarNotSupportA background customization rule exists or a parameter of this configuration is invalid. For more information, submit a ticket.A background custom rule exists or a configured parameter is invalid. For more information, submit a ticket.
    400EdgeScriptNotSupportJsJavaScript rules are not supported. For more information, submit a ticket.JavaScript rules are not supported. For more information, submit a ticket.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-04-29The Error code has changedView Change Details
    2023-05-25The Error code has changedView Change Details