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

Queries staging environment configurations. You can query multiple feature configurations at a time.

Operation description

Note

The maximum number of times that each user can call this operation per second is 30.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribeCdnDomainStagingConfig

get

*Domain

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

None

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, separated by commas (,). For the features that can be configured, see Feature list. If the feature list that you specify is empty, the response returns empty configurations.	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: The configuration is being validated. configuring: The configuration is in progress. success: The configuration is successful. failed: The configuration failed.	success
ParentId	string	The rule condition ID. This is an optional parameter. You can create rule conditions by configuring the condition function (rule engine) in Domain configuration feature parameters. Rule conditions can match and filter user requests by identifying various parameters carried in the requests. After a rule condition is created, a corresponding ConfigId is generated. The ConfigId can be used as the ParentId parameter and referenced by other functions. This way, rule conditions can be combined with feature configurations to form more flexible configurations. For specific configuration operations, see Batch configure domain names or the ParentId configuration examples below.	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 examples

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

[{
   "functionArgs": [{
     "argName": "Parameter A", 
     "argValue": "Value of A"
    }, 
  {
    "argName": "Parameter B", 
    "argValue": "Value of B"
     }], 
 "functionName": "Function name",
 "parentId": "Optional. Rule configid."
}]

The following example shows a configuration that does not use parentId:

When the origin_request_header function is used to add a back-to-origin HTTP request header that references the rule condition whose configid=222728944812032, the request parameters are as follows:

[{
        "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 example shows a configuration that uses parentId:

[{
        "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.