AttachGatewayDomain - Platform For AI - Alibaba Cloud Documentation Center

Binds a custom domain name to a private gateway.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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: internal network. internet: public network.	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

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	40325405-579C-4D82****
GatewayId	string	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******
Message	string	The error message.	Successfully update custom endpoint for gateway gw-1uhcqmsc7x22******

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.