All Products
Search
Document Center

Platform For AI:ListGatewayDomains

Last Updated:Nov 22, 2024

Queries a list of custom domain names of 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.

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
eas:ListGatewayDomainslist
*All Resources
*
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The region where the private gateway resides.

cn-shanghai
GatewayIdstringYes

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

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request.

40325405-579C-4D82****
Messagestring

The message that is returned.

Successfully get custom domains
CustomDomainsarray<object>

The list of custom domain names.

CustomDomainsobject

The details of the custom domain name.

Typestring

The domain name type.

Valid value:

  • intranet: internal network.
  • internet: public network.
intranet
CertificateIdstring

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
Domainstring

The custom domain name.

test.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "40325405-579C-4D82****",
  "Message": "Successfully get custom domains",
  "CustomDomains": [
    {
      "Type": "intranet",
      "CertificateId": "1473**25",
      "Domain": "test.com"
    }
  ]
}

Error codes

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