Query CDN Domain Configuration in Staging via API before Deployment - CDN

Operation description

Note

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify only one domain name in each request.	example.com
FunctionNames	string	No	The list of feature names. Separate multiple values with commas (,). For more information, see A list of features.	aliauth

Response elements

Element	Type	Description	Example
	object
DomainName	string	The accelerated domain name.	example.com
RequestId	string	The request ID.	C80705BF-0F76-41FA-BAD1-5B59296A4E59
DomainConfigs	array<object>	The domain name configurations.
	array<object>
Status	string	The configuration status. Valid values: testing configuring success failed	success
ParentId	string	The rule condition ID. This parameter is optional. To create a rule condition, you can configure the condition feature that is described in the Parameters for configuring features for domain names topic. A rule condition can identify parameters that are included in requests and filter requests based on the identified parameters. Each rule condition has a ConfigId. You can reference ConfigId instead of ParentId in other features. This way, you can combine rule conditions and features for flexible configurations. For more information, see BatchSetCdnDomainConfig or ParentId configuration example in this topic.	222728944812032
ConfigId	string	The configuration ID.	6xx5
FunctionName	string	The feature name.	aliauth
FunctionArgs	array<object>	The description of each feature.
	object
ArgName	string	The configuration name.	auth_type
ArgValue	string	The configuration value.	req_auth

ParentId configuration example

If parentId is set to -1, the existing rule conditions in the configurations are deleted.

[{
   "functionArgs": [{
     "argName": "Parameter A", 
     "argValue": Value of parameter A"
    }, 
  {
    "argName": "Parameter B", 
    "argValue": "Value of parameter B"
     }], 
 "functionName": "Feature name"
 "parentId": "Optional. parentId corresponds to configid of the referenced rule condition"
}]

The following code describes a sample configuration if parentId is not used.

In this example, the origin_request_header feature is used to add origin HTTP headers, and the rule condition whose configuration ID is 222728944812032 is referenced.

[{
        "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"
}]

The following code describes a sample configuration if parentId is used.

In the following example, the origin_request_header feature is used to add origin HTTP headers, and the rule condition that corresponds to the 222728944812032 configid is referenced.

[{
        "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"
}]

Examples

Success response

JSON format

{
  "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"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.