All Products
Search
Document Center

Platform For AI:DetachGatewayDomain

Last Updated:Aug 28, 2026

Unbinds a custom domain name from a private gateway.

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

eas:DetachGatewayDomain

delete

*All Resource

*

None None

Request syntax

PUT /api/v2/gateways/{ClusterId}/{GatewayId}/domain/detach HTTP/1.1

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

Request parameters

Parameter

Type

Required

Description

Example

CustomDomain

object

Yes

Information about the custom domain name.

Type

string

Yes

The domain name type.

Valid values:

  • intranet: internal network.

  • internet: public network.

Valid values:

  • intranet :
  • internet :

intranet

Domain

string

Yes

The custom domain name.

test.com

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

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 returned message.

Successfully delete custom endpoint for gateway gw-1uhcqmsc7x22******

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "GatewayId": "gw-1uhcqmsc7x22******",
  "Message": "Successfully delete custom endpoint for gateway gw-1uhcqmsc7x22******\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.