Use AddVodDomain to add an accelerated domain name - ApsaraVideo VOD

Adds a domain name to accelerate in ApsaraVideo VOD.

Operation description

This operation is available only in the China (Shanghai) region.
Before you add a domain name to accelerate, you must activate ApsaraVideo VOD and apply for an Internet content provider (ICP) filing for the domain name. For more information about how to activate ApsaraVideo VOD, see Activate ApsaraVideo VOD.
If the content on the origin server is not stored on Alibaba Cloud, the content must be reviewed by Alibaba Cloud. The review will be complete by the end of the next business day after you submit an application.
You can add only one domain name to accelerate in a request. You can add a maximum of 20 accelerated domain names within an Alibaba Cloud account.

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:AddVodDomain

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The domain name that you want to accelerate. Wildcard domain names that start with periods (.) are supported. Example: .example.com.	example.com
Sources	string	Yes	The information about the addresses of origin servers. For more information, see the Sources table in this topic.	[{"content":"1.1.1.1","type":"ipaddr","priority":"20","port":80}]
CheckUrl	string	No	The URL that is used for health checks.	www.example.com/test.html
Scope	string	No	This parameter is applicable to users of level 3 or higher in the Chinese mainland and users outside the Chinese mainland. Default value: domestic. Valid values: domestic: Chinese mainland overseas: outside the Chinese mainland global: regions in and outside the Chinese mainland	domestic
TopLevelDomain	string	No	The top-level domain.	example.com

Sources

Parameter	Type	Required	Description
type	String	Yes	The type of the origin server. Valid values: ipaddr: an IP address. domain: a domain name. oss: the domain of an Object Storage Service (OSS) bucket.
content	String	Yes	The address of the origin server. You can specify an IP address or a domain name.
port	Integer	No	The port number. Valid values: 443 and 80. Default value: 80. If you specify 443, requests are redirected to the origin server over HTTPS. You can also specify a custom port.
priority	String	No	The priority of the origin server if multiple origin servers are specified. Valid values: 20 and 30. Default value: 20. 20 indicates that the origin server is the primary origin server. 30 indicates that the origin server is a secondary origin server.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	15C66C7B-671A-4297-****-2C4477247A74

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-****-2C4477247A74"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDomainName.Malformed	Specified DomainName is malformed.
400	MissingParameter	The input parameter cdnType that is mandatory for processing this request is not supplied.
400	InvalidCdnType.Malformed	Specified CdnType is malformed.
400	InvalidSources.Malformed	Specified Sources is malformed.	The origin information is in an invalid format.
400	InvalidSourceStr.Malformed	Specified SourceStr is malformed.	The format of the incoming source information is incorrect.
400	InvalidSourceType.Malformed	Specified CdnType is malformed.
400	InvalidSource.Priority.Malformed	The specified Source Priority is invalid.
400	InvalidTypeAndContent.MissMatch	The specified source type does not match the specified source content.
400	InvalidScope.Malformed	Specified Scope is malformed.
400	DomainOverLimit	The Number of Domain is over the limit
400	DomainAlreadyExist	This domain name is exist already
400	DomainNotRegistration	The Domain name is not registered
400	InvaildParameter	Source name can not equal to domain name
400	IllegalSources	The specified origin site information is invalid.	The origin information of the accelerated domain name is incorrect.
400	SourceIp.Exceed	The Certificate you provided is malformed!
400	InvalidCertificate	The Certificate you provided is malformed!
400	InvalidCertificate.TooLong	The Certificate you provided is over the max length!
400	InnerAddDomainDenied	Your account haven't bind aoneId, can not add domain.
400	CheckSourceHealthFailed	sources ip or source domain check health failed,please input right source.
400	ExtensiveAndAllBothExist	Extensive domain and the domain begins with 'all.' can not exist at the same time.
400	CdnTypeNotSupportExtensiveDomain	Extensive domain not supported for this cdn type.
400	ExtensiveAndSpecificDomainConflict	Extensive domain and corresponding specific domain are mutually exclusive.	Wildcard domain names and specific domain names of the same level as the wildcard domain names are mutually exclusive. Enter another domain name.
400	DomainReserved	The root domain of your domain is reserved by another account. Submit a ticket to contact customer support.	The root domain name is already in use. Submit a ticket.
400	InvalidDomainNameLevel	Domain name suffixed with alicdn.com only support third level.
400	InvalidTopLevelDomain.Malformed	Specified TopLevelDomain is malformed.
400	TopLevelDomain.NotFound	The specified TopLevelDomain does not exist.
400	EntityNotExists.ResourceGroup	The resource group does not exist.
400	InvalidStatus.ResourceGroup	It's now allowed to do this operation because of the current status of resource-group.
400	NotInternationRealIdentity	You need to do real name authentication when you use Chinese mainland resources.	You have not passed real-name verification. According to the regulations issued by MIIT, you must pass real-name verification if you want to purchase IT services in the Chinese mainland.
400	TopLevelDomain.Mismatch	The specified TopLevelDomain does not match webSiteType.
400	DomainOwnerVerifyFail	Owner verification of the root domain failed.	Failed to verify domain ownership.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.