Use DescribeVodDomainConfigs to query domain name configurations - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries domain name configurations. You can query multiple feature configurations in a single request.

Operation description

Currently, the service address supports only China (Shanghai).

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

vod:DescribeVodDomainConfigs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name for ApsaraVideo VOD. Only a single domain name can be queried at a time.	www.example.com
FunctionNames	string	Yes	The feature names. You can query multiple feature configurations in a single request. Separate multiple feature names with commas (,). For the features supported by accelerated domain names for ApsaraVideo VOD and their names, see Feature functions for domain name configuration.	filetype_based_ttl_set,set_req_host_header

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F8AA0364-0FDB-4AD5-****-D69FAB8924ED
DomainConfigs	object
DomainConfig	array<object>	The domain name configurations.
	array<object>	The details of the domain name configuration.
Status	string	The status of the domain name configuration. Valid values: success: The configuration is successful. testing: The configuration is being tested. failed: The configuration failed. configuring: The feature is being configured.	success
ConfigId	string	The ID of the configuration.	5003576
FunctionName	string	The name of the feature.	set_req_host_header
FunctionArgs	object
FunctionArg	array<object>	The details of the feature configuration.
	object	The details of the feature configuration.
ArgName	string	The name of the parameter, which is a configuration item of functionName.	domain_name
ArgValue	string	The value of the parameter, which is the value of the configuration item for functionName.	example.com

Examples

Success response

JSON format

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

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.