Retrieve MSE Gateway Domains via ListGatewayDomain API - Microservices Engine - Alibaba Cloud - Microservices Engine

Queries the list of associated domains for a 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

mse:ListGatewayDomain

list

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-c9bc5afd61014165bd58f621b491****
Type	string	No	The domain name type.	All
DomainName	string	No	Fuzzy match by domain name.	example.com
AcceptLanguage	string	No	The language of the returned information. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	3F5D8E93-CA66-57F1-8BCF-A223E11B6B91
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message.	You are not authorized to perform this operation.
Code	integer	The return code.	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 node data.
	array<object>	The data structure.
Id	integer	The domain name ID.	243
Name	string	The domain name.	test.com
Protocol	string	The protocol.	HTTP
MustHttps	boolean	Indicates whether HTTPS is enforced.	true
CertIdentifier	string	The certificate ID.	3452-cn-hangzhou
CertBeforeDate	string	The certificate expiration time (deprecated, view details on the domain name details page).	2031-03-30 02:35:12
GatewayId	integer	The gateway ID.	12
GmtCreate	string	The time when the domain name record was created.	2031-03-30 02:35:12
GmtModified	string	The time when the domain name record was last modified.	2031-03-30 02:35:12
Status	integer	The domain name status. Valid values: 0: Not published. 2: Publishing. 3: Published. 4: Editing. 5: Unpublishing. 6: Unavailable.	3
Type	string	The domain name source type. Valid values: Op: Created from the console. Ingress: Created by MSE Ingress.	Op
Comment	object	The route comment (ingress).
Status	string	The status	Error
Http2	string	Indicates whether `Http2` is enabled. Valid values: `open`: Http2 is enabled. `close`: Http2 is disabled. `globalConfig`: The global configuration is used.	close
TlsMax	string	The maximum TLS version.	TLS 1.3
TlsMin	string	The minimum TLS version.	TLS 1.0
IsManaged	boolean	Indicates whether the domain name is managed.
TlsCipherSuitesConfig	object
ConfigType	string
TlsCipherSuites	array
	string
EnableWaf	boolean
SupportWaf	boolean

Examples

Success response

JSON format

{
  "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",
      "IsManaged": false,
      "TlsCipherSuitesConfig": {
        "ConfigType": "",
        "TlsCipherSuites": [
          ""
        ]
      },
      "EnableWaf": false,
      "SupportWaf": false
    }
  ]
}

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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.