All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodDomainConfigs

Last Updated:May 22, 2024

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.

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
vod:DescribeVodDomainConfigsRead
  • All Resources
    *
    none
none
vod:DescribeVodDomainConfigsRead
  • All Resources
    *
    none
none
vod:DescribeVodDomainConfigsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The domain name for CDN.

www.example.com
FunctionNamesstringYes

The feature name. Separate multiple names with commas (,). For more information, see Feature description.

filetype_based_ttl_set,set_req_host_header

Feature description

FeatureDescription
referer_white_list_setSpecifies the referer whitelist.
referer_black_list_setSpecifies the referer blacklist.
filetype_based_ttl_setSpecifies a time-to-live (TTL) period for a file.
path_based_ttl_setSpecifies a TTL period for a directory.
cc_defenseConfigures protection against HTTP flood attacks.
oss_authConfigures authentication for access to an Object Storage Service (OSS) bucket.
ip_black_list_setSpecifies the IP address blacklist.
ip_white_list_setSpecifies the IP address whitelist.
error_pageRedirects an error page to a specific page.
teslaOptimizes pages to accelerate access.
set_req_host_headerModifies the custom header of back-to-origin requests.
set_hashkey_argsIgnores the specified URL parameters.
aliauthConfigures Alibaba Cloud authentication.
set_resp_headerConfigures a response header. To verify the setting, you can check the response message from a browser.
video_seekConfigures video seeking.
rangeConfigures object chunking.
gzipOptimizes pages by using GNU zip (Gzip) compression.
https_forceConfigures redirection from HTTP to HTTPS.
http_forceConfigures redirection from HTTPS to HTTP.
alivodConfigures ApsaraVideo VOD.
forward_schemeConfigures the origin protocol and origin port.
tmd_signatureConfigures a custom rate limiting rule.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

F8AA0364-0FDB-4AD5-****-D69FAB8924ED
DomainConfigsobject []

The configurations of the domain name.

Statusstring

The configuration status. Valid values:

  • success
  • testing
  • failed
  • configuring
success
ConfigIdstring

The configuration ID.

5003576
FunctionNamestring

The feature name.

set_req_host_header
FunctionArgsobject []

The feature parameters.

ArgNamestring

The parameter name.

file_type
ArgValuestring

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 codeError messageHTTP status codeDescription
DeleteFunctionFailedBatch delete functions failed.400The error message returned because you failed to delete multiple features.
InvalidFunctionName.ValueNotSupportedFunctionName %s is not supported.400The error message returned because the %s feature name is invalid.