ListGatewayDomain - Microservices Engine - Alibaba Cloud Documentation Center

Queries the domain names that are associated with a 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

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.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListGatewayDomain	get	Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-c9bc5afd61014165bd58f621b491****
Type	string	No	The type of the domain name.	All
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	3F5D8E93-CA66-57F1-8BCF-A223E11B6B91
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The error message returned if the request failed.	You are not authorized to perform this operation.
Code	integer	The status code returned.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	array<object>	The details of the data.
Domains	object	The data structure.
Id	long	The ID of the domain name.	243
Name	string	The domain name.	test.com
Protocol	string	The protocol.	HTTP
MustHttps	boolean	Indicates whether HTTPS is forcefully used.	true
CertIdentifier	string	The certificate ID.	3452-cn-hangzhou
CertBeforeDate	string	The time when the certificate expires.	2031-03-30 02:35:12
GatewayId	long	The gateway ID.	12
GmtCreate	string	The time when the domain name was created.	2031-03-30 02:35:12
GmtModified	string	The time when the domain name was updated.	2031-03-30 02:35:12
Status	integer	The state of the domain name. Valid values: 0: unpublished 2: publishing 3: published 4: editing 5: unpublishing 6: unavailable	3
Type	string	The type of the domain name source. Valid values: Op: console Ingress: MSE Ingress	Op
Comment	object	The route comment. This parameter is returned only in ingress scenarios.
Status	string	The route status.	Error
Http2	string	Indicates whether `HTTP/2` is enabled. `open`: `HTTP/2` is enabled. `close`: `HTTP/2` is disabled. `globalConfig`: Global configurations are used.	close
TlsMax	string	The maximum version of Transport Layer Security (TLS).	TLS 1.3
TlsMin	string	The minimum version of TLS.	TLS 1.0

Examples

Sample success responses

JSONformat

{
  "RequestId": "3F5D8E93-CA66-57F1-8BCF-A223E11B6B91",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": 243,
      "Name": "test.com",
      "Protocol": "HTTP",
      "MustHttps": true,
      "CertIdentifier": "3452-cn-hangzhou",
      "CertBeforeDate": " 2031-03-30 02:35:12",
      "GatewayId": 12,
      "GmtCreate": " 2031-03-30 02:35:12",
      "GmtModified": " 2031-03-30 02:35:12",
      "Status": 3,
      "Type": "Op",
      "Comment": {
        "Status": "Error"
      },
      "Http2": "close",
      "TlsMax": "TLS 1.3",
      "TlsMin": "TLS 1.0"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

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

Change history

Change time	Summary of changes	Operation
2024-01-18	The request parameters of the API has changed	View Change Details