ModifyDomainResource - Anti-DDoS - Alibaba Cloud Documentation Center

Modifies the forwarding rule of a website.

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

yundun-ddoscoo:ModifyDomainResource

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Domain	string	Yes	The domain name that is added to the Anti-DDoS Pro or Anti-DDoS Premium instance.	www.example.com
RsType	integer	Yes	The address type of the origin server. Valid values: 0: IP address 1: domain name If you deploy proxies, such as a Web Application Firewall (WAF) instance, between the origin server and the Anti-DDoS Pro or Anti-DDoS Premium instance, set the value to 1. If you use the domain name, you must enter the address of the proxy, such as the CNAME of WAF.	0
HttpsExt	string	No	The advanced HTTPS settings. This parameter takes effect only when the value of the ProxyType parameter includes https. The value is a string that consists of a JSON struct. The JSON struct contains the following fields: Http2https: specifies whether to turn on Enforce HTTPS Routing. This field is optional and must be an integer. Valid values: 0 and 1. The value 0 indicates that Enforce HTTPS Routing is turned off. The value 1 indicates that Enforce HTTPS Routing is turned on. The default value is 0. If your website supports both HTTP and HTTPS, this feature meets your business requirements. If you enable this feature, all HTTP requests to access the website are redirected to HTTPS requests on the standard port 443. Https2http: specifies whether to turn on Enable HTTP. This field is optional and must be an integer. Valid values: 0 and 1. The value 0 indicates that Enable HTTP is turned off. The value 1 indicates that Enable HTTP is turned on. The default value is 0. If your website does not support HTTPS, this feature meets your business requirements If this feature is enabled, all HTTPS requests are redirected to HTTP requests and forwarded to origin servers. This feature can redirect WebSockets requests to WebSocket requests. Requests are redirected over the standard port 80. Http2: specifies whether to turn on Enable HTTP/2. This field is optional. Data type: integer. Valid values: 0 and 1. The value 0 indicates that Enable HTTP/2 is turned off. The value 1 indicates that Enable HTTP/2 is turned on. The default value is 0. After you turn on the switch, HTTP/2 is used.	{"Http2":1,"Http2https":1,"Https2http":1}
ProxyTypes	array<object>	Yes	The details about the protocol type and port number.
	object	No
ProxyPorts	array	Yes	The port numbers.
	integer	No	The port number. Note You must specify a port within the port range supported by the Anti-DDoS Pro or Anti-DDoS Premium instance. For more information, see Custom non-standard ports.	443
ProxyType	string	No	The type of the protocol. Valid values: http https websocket websockets	https
RealServers	array	Yes	An array that consists of the addresses of origin servers.
	string	No	The address of the origin server. If you set the RsType parameter to 0, set the value to the IP address of the origin server. If you set the RsType parameter to 1, set the value to the domain name of the origin server. For more information, see the description of the RsType parameter.	1.XX.XX.1
InstanceIds	array	Yes	An array consisting of the IDs of instances that you want to associate.
	string	No	The ID of instance that you want to associate. If you do not specify this parameter, only the domain name of the website is added but no instances are associated with the website. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-mp91j1ao****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	39499F01-19D9-4EA4-A0E9-C6014BA5CDBE

Examples

Success response

JSON format

{
  "RequestId": "39499F01-19D9-4EA4-A0E9-C6014BA5CDBE"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.