UpdateDcdnIpaDomain - Edge Security Acceleration - Alibaba Cloud Documentation Center

You can call the UpdateDcdnIpaDomain operation to modify an accelerated domain name for IPA.

Operation description

Note

The throttling limit for a single user is 20 calls per second.

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

dcdn:UpdateDcdnIpaDomain

update

*IpaDomain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The domain name to accelerate with IP Application Accelerator (IPA). You can modify only one domain name at a time.	example.com
Sources	string	No	The list of origin addresses.	[{"content":"10.10.10.10","type":"ipaddr","priority":"20","port":80,"weight":"15"}]
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmyuji4b6r4**
TopLevelDomain	string	No	The top-level domain.	example.edu

The following table describes the fields in 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: an OSS domain name.
content	String	Yes	The origin URL. This can be an IP address or a domain name.
port	Integer	No	The custom port. Valid values: 0 to 65535.
priority	String	No	The priority of the origin server. Valid values are 20 (default) and 30. A value of 20 indicates the primary origin server and 30 indicates the secondary origin server.
weight	String	No	The weight for origin fetch. The value must be less than 100. The default value is 10.

Response parameters

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	MissingDomainName	The domainName parameter is required.	The domain name parameter is not specified.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.
400	InvalidSource.Content.Malformed	The specified Source Content is invalid.	The information about the origin server is invalid.
400	InvalidTypeContent.Mismatch	The specified source type does not match the specified source content.	The specified origin server type does not match the type of the specified origin server. Specify a valid value and try again.
400	MissingSource.Content	The Source Content must be specified.	No value is specified for the content field in the Sources parameter.
400	MissingSource.Type	The Source Type must be specified.	No value is specified for the type field in the Sources parameter.
400	InvalidSource.Type.Malformed	The specified Source Type is invalid.	The value specified for the type field in the Sources parameter is invalid.
400	InvalidSource.Priority.Malformed	The specified Source Priority is invalid.	The value specified for the priority field in the Sources parameter is invalid.
400	InvalidResourceGroupId.Malformed	The specified ResourceGroupId is invalid.	The value specified for the ResourceGroupId parameter is invalid. Specify a valid value and try again.
400	EntityNotExists.ResourceGroup	The resource group does not exist.	The specified resource group does not exist.
400	EntityNotExist.ResourceGroup	The resource group does not exist.	The specified resource group does not exist.
400	InvalidStatus.ResourceGroup	The 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.
400	TopLevelDomain.NotFound	The specified TopLevelDomain does not exist.	The specified top-level domain name does not exist.
400	InvalidSource.Port.Malformed	The source port is empty, or it is outside the range 0-65535.	No port is specified or the specified port number is invalid. Valid values: 0 to 65535.
403	DomainInProtectedMode	The domain is in protection mode. To request permission, contact Customer Service.	The specified domain name is in the protected mode. If you must perform this operation, contact customer service.
403	DcdnIpaServiceNotFound	The DCDN IPA service has not been activated.	IPA is not activated for DCDN.
404	NoResource	The required port has no resources, please submit a ticket.	The required port has no resources, please submit a ticket.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.