Retrieve Private Gateway Domains via ListGatewayDomains API - Platform For AI - Alibaba Cloud - Platform For AI

Queries the list of custom domain names for a dedicated 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:ListGatewayDomains

list

*All Resource

*

None

Request syntax

GET /api/v2/gateways/{ClusterId}/{GatewayId}/domains HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The region where the dedicated gateway resides.	cn-shanghai
GatewayId	string	Yes	The dedicated gateway ID. To obtain the dedicated gateway ID, refer to the GatewayId field in the response of the ListGateway operation.	gw-1uhcqmsc7x22******

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	40325405-579C-4D82****
Message	string	The response message.	Successfully get custom domains
CustomDomains	array<object>	The list of custom domain names.
	object	The details of the custom domain name.
Type	string	The domain name type. Valid values: intranet : internal domain name. internet : public domain name.	intranet
CertificateId	string	The ID of the SSL certificate bound to the domain name. Obtain the certificate ID after uploading or purchasing a certificate in Certificate Management Service.	1473**25
Domain	string	The custom domain name.	test.com
CertificateName	string	The SSL certificate name.	cert-9955038
CertificateStartDate	string	The certificate issuance date in the YYYY-MM-DD format.	2018-07-13
CertificateEndDate	string	The certificate expiration date in the YYYY-MM-DD format.	2023-10-25
CreateTime	string	The time when the domain name was created, in UTC and RFC 3339 format.	2020-05-19T14:19:42Z
UpdateTime	string	The time when the domain name was last updated, in UTC and RFC 3339 format.	2021-05-19T14:19:42Z
CertificateStatus	string	The domain name status. Valid values: Succeeded : Succeeded. Failed : Failed. Attaching : Binding in progress. Deleting : Deleting in progress.	Succeeded

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "Message": "Successfully get custom domains",
  "CustomDomains": [
    {
      "Type": "intranet",
      "CertificateId": "1473**25",
      "Domain": "test.com",
      "CertificateName": "cert-9955038",
      "CertificateStartDate": "2018-07-13",
      "CertificateEndDate": "2023-10-25",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-05-19T14:19:42Z",
      "CertificateStatus": "Succeeded"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.