All Products
Search
Document Center

Anti-DDoS:CreateDomainResource

Last Updated:Oct 23, 2024

Creates a forwarding rule for a website.

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
yundun-ddoscoo:CreateDomainResourcecreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainstringYes

The domain name of the website that you want to add to the Anti-DDoS Pro or Anti-DDoS Premium instance.

www.example.com
RsTypeintegerYes

The address type of the origin server. Valid values:

  • 0: IP address.

  • 1: domain name.

    This parameter is suitable for scenarios in which another proxy service, such as Web Application Firewall (WAF), is deployed between the origin server and Anti-DDoS Proxy. The address is the redirection address of the proxy service, such as the CNAME of WAF.

0
HttpsExtstringNo

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}
InstanceIdsarrayYes

An array consisting of the IDs of instances that you want to associate.

stringYes

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****
RealServersarrayYes

An array that consists of the addresses of origin servers.

stringYes

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
ProxyTypesarray<object>Yes

The details about the protocol type and port number.

objectYes
ProxyPortsarrayYes

The port numbers.

integerNo

The port number.

Note You must specify a port within the port range supported by the Anti-DDoS Proxy instance. For more information, see Custom non-standard ports.
80
ProxyTypestringNo

The type of the protocol. Valid values:

  • http
  • https
  • websocket
  • websockets
http

Response parameters

ParameterTypeDescriptionExample
object

The data body that is returned for the request.

RequestIdstring

The ID of the request.

39499F01-19D9-4EA4-A0E9-C6014BA5CDBE

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-30API Description UpdateView Change Details
2023-05-26The internal configuration of the API is changed, but the call is not affectedView Change Details