All Products
Search
Document Center

CDN:ModifyCdnDomain

Last Updated:Nov 29, 2024

Modifies the configuration of an accelerated domain name.

Operation description

Note You can call this operation up to 30 times per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify only one domain name in each request.

example.com
SourcesstringNo

The information about the addresses of origin servers.

Note Do not set Sources and TopLevelDomain at the same time. If you set Sources and TopLevelDomain at the same time, TopLevelDomain does not take effect.
[{"content":"1.1.1.1","type":"ipaddr","priority":"20","port":80,"weight":"15"}]
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmyuji4b6r4**
TopLevelDomainstringNo

The root domain. To add a root domain name, you must be added to the whitelist specified by the CDN_TOP_LEVEL_DOMAIN_GREY_USER_LIST parameter.

Note Do not set Sources and TopLevelDomain at the same time. If you set Sources and TopLevelDomain at the same time, TopLevelDomain does not take effect.
aliyundoc.com

The following table describes the fields in the Sources parameter.

FieldTypeRequiredDescription
typeStringYesThe type of the origin server.ipaddr: an IP addressdomain: a domain nameoss: the domain name of an Object Storage Service (OSS) bucketfc_domain: a Function Compute domain name
contentStringYesThe address of the origin server. You can specify an IP address or a domain name.
portIntegerNoThe port number. You can specify port 80, port 443, or a custom port. Default value: 80. If you specify port 443, CDN 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.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Sample success responses

JSONformat

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status codeError codeError messageDescription
400Abs.Sources.MalformedThe specified Sources is invalid.The specified origin is invalid.
400MissingDomainNameThe domainName parameter is required.-
400InvalidDomainName.MalformedThe specified DomainName is invalid.The specified domain name is invalid.
400InvalidSource.Content.MalformedThe specified Source Content is invalid.The specified origin address is invalid.
400InvalidTypeContent.MismatchThe specified source type does not match the specified source content.-
400MissingSource.ContentThe Source Content must be specified.You must specify the origin information.
400MissingSource.TypeThe Source Type must be specified.-
400InvalidSource.Type.MalformedThe specified Source Type is invalid.-
400InvalidSource.Priority.MalformedThe specified Source Priority is invalid.-
400InvalidResourceGroupId.MalformedThe specified ResourceGroupId is invalid.-
400EntityNotExists.ResourceGroupThe resource group does not exist.The specified ResourceGroup parameter does not exist.
400EntityNotExist.ResourceGroupThe resource group does not exist.The specified resource group does not exist.
400InvalidStatus.ResourceGroupIt is not allowed to do this operation because of the current status of resource-group.This operation is not supported while the resource group is in the current state.
400TopLevelDomain.NotFoundTopLevelDomain is not exist.The specified TopLevelDomain parameter does not exist.
400InvalidTopLevelDomain.MalformedSpecified TopLevelDomain is malformed.The specified TopLevelDomain parameter is invalid.
400TopLevelDomain.MismatchThe specified TopLevelDomain does not match webSiteType.The top-level domain name does not match the domain name type.
403DomainInProtectedModeThe domain is in protection mode. To request permission, contact Customer Service.-

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

Change history

Change timeSummary of changesOperation
2023-06-08The Error code has changedView Change Details