DescribeCdnDomainStagingConfig - CDN - Alibaba Cloud Documentation Center

Queries the configurations of features 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cdn:DescribeCdnDomainStagingConfig	get	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	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. Separate multiple values with commas (,). For more information, see A list of features.	aliauth

Response parameters

Parameter	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.
DomainConfig	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.
FunctionArg	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

Sample success responses

JSONformat

{
  "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.	The specified method is not supported.

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

Change history

Change time	Summary of changes	Operation

No change history