DescribeVodDomainConfigs - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the configurations of a domain name for CDN. You can query the configurations of multiple features at a time.

Operation description

Note This operation is available only in the China (Shanghai) region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The domain name for CDN.	www.example.com
FunctionNames	string	Yes	The feature name. Separate multiple names with commas (,). For more information, see Feature description.	filetype_based_ttl_set,set_req_host_header

Feature description

Feature	Description
referer_white_list_set	Specifies the referer whitelist.
referer_black_list_set	Specifies the referer blacklist.
filetype_based_ttl_set	Specifies a time-to-live (TTL) period for a file.
path_based_ttl_set	Specifies a TTL period for a directory.
cc_defense	Configures protection against HTTP flood attacks.
oss_auth	Configures authentication for access to an Object Storage Service (OSS) bucket.
ip_black_list_set	Specifies the IP address blacklist.
ip_white_list_set	Specifies the IP address whitelist.
error_page	Redirects an error page to a specific page.
tesla	Optimizes pages to accelerate access.
set_req_host_header	Modifies the custom header of back-to-origin requests.
set_hashkey_args	Ignores the specified URL parameters.
aliauth	Configures Alibaba Cloud authentication.
set_resp_header	Configures a response header. To verify the setting, you can check the response message from a browser.
video_seek	Configures video seeking.
range	Configures object chunking.
gzip	Optimizes pages by using GNU zip (Gzip) compression.
https_force	Configures redirection from HTTP to HTTPS.
http_force	Configures redirection from HTTPS to HTTP.
alivod	Configures ApsaraVideo VOD.
forward_scheme	Configures the origin protocol and origin port.
tmd_signature	Configures a custom rate limiting rule.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F8AA0364-0FDB-4AD5-****-D69FAB8924ED
DomainConfigs	array<object>	The configurations of the domain name.
	object	The configurations of the domain name.
Status	string	The configuration status. Valid values: success testing failed configuring	success
ConfigId	string	The configuration ID.	5003576
FunctionName	string	The feature name.	set_req_host_header
FunctionArgs	array<object>	The feature parameters.
	object	The parameters of each feature.
ArgName	string	The parameter name.	file_type
ArgValue	string	The parameter value.	txt

Examples

Sample success responses

JSONformat

{
  "RequestId": "F8AA0364-0FDB-4AD5-****-D69FAB8924ED",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ConfigId": "5003576",
        "FunctionName": "set_req_host_header",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "file_type",
              "ArgValue": "txt"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
DeleteFunctionFailed	Batch delete functions failed.	400	The error message returned because you failed to delete multiple features.
InvalidFunctionName.ValueNotSupported	FunctionName %s is not supported.	400	The error message returned because the %s feature name is invalid.