All Products
Search

This Product

    Dynamic Content Delivery Network:AddDcdnDomain

    Document Center

    Dynamic Content Delivery Network:AddDcdnDomain

    Last Updated:May 21, 2024

    Adds a domain name to accelerate. You can specify only one domain name in each request.

    Operation description

    Note
  • Dynamic Content Delivery Network (DCDN) is activated.
  • Internet content provider (ICP) filing is complete for the accelerated domain name.
  • If the content of the origin server is not stored on Alibaba Cloud, the content must be reviewed. After you submit the request, the review is complete by the end of the following business day.
  • You can call this operation up to 30 times per second per account.
    •

    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
    dcdn:AddDcdnDomainWrite
    • Domain
      acs:dcdn:*:{#accountId}:domain/{#DomainName}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DomainNamestringYes

    The domain name that you want to add. You can specify only one domain name in each request.

    Wildcard domain names are supported. A wildcard domain name must start with a period (.), such as .example.com.

    		example.com
    ResourceGroupIdstringNo

    The ID of the resource group. If you do not specify a value for this parameter, the system automatically assigns the ID of the default resource group.

    		rg-acfmyuji4b6r4**
    SourcesstringNo

    The information about the addresses of origin servers.

    		[{"content":"10.10.10.10","type":"ipaddr","priority":"20","port":80}]
    CheckUrlstringNo

    The URL that is used for health checks.

    		example.com
    ScopestringNo

    The acceleration region. Valid values:

    • domestic: Chinese mainland
    • overseas: outside the Chinese mainland
    • global: global

    Default value: domestic.

    		domestic
    TopLevelDomainstringNo

    The top-level domain.

    		yourTopLevelDomain
    Tagobject []No

    The information about the tags.

    KeystringNo

    The key of a tag. Valid values of N: 1 to 20.

    		env
    ValuestringNo

    The value of a tag. Valid values of N: 1 to 20.

    		value
    ScenestringNo

    The Acceleration scen. Supported:

    • apiscene:API acceleration.
    • webservicescene: accelerate website business.
    • staticscene: video and graphic acceleration.
    • (Empty): no scene.
    		apiscene
    FunctionTypestringNo

    Computing service type. Valid values:

    • routine
    • image
    • cloudFunction
    		routine

    The following table describes the fields in the Sources parameter.

    FieldTypeRequiredDescription
    typeStringYesThe type of the origin server. A value of ipaddr specifies the IP address of the origin server. A value of domain specifies the domain name of the origin server. A value of oss specifies the domain name of an Object Storage Service (OSS) bucket.
    contentStringYesThe address of the origin server. You can specify an IP address or a domain name.
    portIntegerNoThe port number. You can set the port parameter to 443, 80, or a custom port. Default value: 80. If you specify port 443, DCDN communicates with the origin server over HTTPS.
    priorityStringNoThe priority of the origin server if multiple origin servers are specified. Valid values: 20 and 30. Default value: 20. A value of 20 specifies that the origin is a primary origin. A value of 30 specifies that the origin is a secondary origin.
    weightStringNoThe weight of the origin server if multiple origin servers are specified. You must specify a value that is less than 100. Default value: 10.

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		15C66C7B-671A-4297-9187-2C4477247A74

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDomainName.MalformedThe specified DomainName is invalid.The specified domain name is invalid.
    400InvalidSource.Content.MalformedThe specified Source Content is invalid.The information about the origin server is invalid.
    400MissingSource.ContentThe Source Content must be specified.No value is specified for the content field in the Sources parameter.
    400MissingSource.TypeThe Source Type must be specified.No value is specified for the type field in the Sources parameter.
    400InvalidSource.Type.MalformedThe specified Source Type is invalid.The value specified for the type field in the Sources parameter is invalid.
    400InvalidSource.Priority.MalformedThe specified Source Priority is invalid.The value specified for the priority field in the Sources parameter is invalid.
    400InvalidScope.MalformedThe specified Scope is invalid.The value specified for the Scope parameter is invalid.
    400SourceIp.ExceedThe maximum number of back-to-origin IP addresses is exceeded.The number of origin IP addresses exceeds the upper limit.
    400InvalidCertificateThe specified certificate format is invalid.The format of the specified certificate is invalid.
    400InvalidCertificate.TooLongThe maximum length of the certificate is exceeded.The maximum length of the specified certificate content has been reached.
    400CheckSourceHealthFailedError checking the security. Provide the valid origin site information.Security check failed due to invalid information about the origin server.
    400ExtensiveAndAllBothExistA wildcard domain name and a domain name with an all. prefix cannot be both specified.Wildcard domain names and domain names that start with "all." cannot both exist.
    400CdnTypeNotSupportExtensiveDomainWildcard domain names are not supported.Wildcard domain names are not supported.
    400ExtensiveAndSpecificDomainConflictThe wildcard domain name overlaps a domain name at the same level.Wildcard domain names and specific domain names of the same level as the wildcard domain names are mutually exclusive. Enter another domain name.
    400InvalidResourceGroupId.MalformedThe specified ResourceGroupId is invalid.The value specified for the ResourceGroupId parameter is invalid. Specify a valid value and try again.
    400DomainReservedThe root domain of your domain is reserved by another account. Submit a ticket to contact customer support.The root domain name of this domain name is used by another account. Submit a ticket to apply for new domain names.
    400InvalidDomainNameLevelThe alicdn.com domain supports a maximum of three levels of domain.alicdn.com supports up to three domain levels for wildcard domain names.
    400EntityNotExists.ResourceGroupThe resource group does not exist.The specified resource group does not exist.
    400InvalidStatus.ResourceGroupThe current status of the resource group does not support this operation.This operation is not supported while the resource group is in the current state.
    400NotInternationRealIdentityReal-name registration is required for services offered in Mainland China.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 information services in the Chinese mainland.
    400TopLevelDomain.NotFoundThe specified TopLevelDomain does not exist.The specified top-level domain name does not exist.
    400RecordCheckNotAvailableThe ICP filing interface is unavailable. Please try again later.The operation for ICP filing is unavailable. Try again later.
    400IcpBlackThe domain is on the ICP blacklist.The domain name is on the blacklist of the MIIT.
    400IspBlackThe domain is on the ISP blacklist.The domain name is on the blacklist of Alibaba Cloud.
    400InvalidCheckUrl.MalformedThe specified CheckUrl is invalid.The CheckUrl parameter is set to an invalid value.
    400DomainOwnerVerifyFailOwner verification of the root domain failed.The first time a domain name is added to DCDN, you must prove the ownership of the domain name. You must add a DNS record or upload a verification file for the domain name before it can be added to DCDN.
    400TopLevelDomain.MismatchThe specified TopLevelDomain does not match webSiteType.The top-level domain name does not match the domain name type.
    400DomainInBlacklistThe domain is in the blacklist.The domain name is in the blacklist.
    400DomainOverLimitThe maximum number of domains is exceeded.The maximum number of domain names has been reached.
    400SourceInBlacklistSource is in the blacklist.The origin server is in the blacklist.
    400InvalidTagKeyThe key should not be null, start with "acs:" or "aliyun", contain "http://" or "https://" or have special symbols:.!@#$%?/^&*)(+={}[]",'<>~·`?;.-
    400InvalidTagValueThe tag value cannot contain these special symbols:http://, https://-
    400ReservedTagKeyThe tag key is used internally as a reserved field and is not allowed to be used.-
    400InvalidFunctionType.MalformedThe specified FunctionType is invalid.-
    400InvalidfunctionType.MalformedFunctionType is malformed.-

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

    Change history

    Change timeSummary of changesOperation
    2023-12-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-12-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-08-29The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: FunctionType