Binds a custom domain name to a private gateway.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| eas:AttachGatewayDomain | update | *All Resources * |
| none |
Request syntax
PUT /api/v2/gateways/{ClusterId}/{GatewayId}/domain/attach HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClusterId | string | Yes | The region where the private gateway resides. | cn-shanghai |
| GatewayId | string | Yes | The ID of the private gateway. To obtain the private gateway ID, see the GatewayId parameter in the response parameters of the ListGateway operation. | gw-1uhcqmsc7x22****** |
| CustomDomain | object | Yes | The custom domain name information. | |
| Type | string | Yes | The domain name type. Valid value:
| intranet |
| CertificateId | string | No | The ID of the SSL certificate bound to the domain name. Obtain the certificate ID after you upload or purchase a certificate in the Certificate Management Service console. | 1473**25 |
| Domain | string | Yes | The custom domain name. | test.com |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "40325405-579C-4D82****",
"GatewayId": "gw-1uhcqmsc7x22******",
"Message": "Successfully update custom endpoint for gateway gw-1uhcqmsc7x22******\n"
}Error codes
For a list of error codes, visit the Service error codes.
