GetGatewayDomainDetail - Microservices Engine - Alibaba Cloud Documentation Center

Queries the details of a domain name associated with 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:GetGatewayDomainDetail

get

*Gateway

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

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The data structure.
RequestId	string	The request ID.	88B83302-CD88-54D3-8DF2-208BFDC73F0D
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	You are not authorized to perform this operation.
Code	integer	The status code.	403
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The returned data.
Id	integer	The ID of the domain name.	12
Name	string	The name of the domain.	test.com
GatewayUniqueId	string	The unique ID of the gateway.	gw-7ea3da97b96543e19f6c597cd4a9****
GatewayId	integer	The gateway ID.	1
Protocol	string	The gateway protocol.	HTTP
MustHttps	boolean	Specifies whether to enforce HTTPS.	true
CertIdentifier	string	The certificate identifier.	234-cn-hangzhou
GmtCreate	string	The time when the domain name was created.	2022-01-07T10:07:57.000+0000
GmtModified	string	The time when the domain name was last modified.	2022-01-07T10:07:57.000+0000
CertName	string	The name of the certificate.	test
CommonName	string	The public domain name.	name
Sans	string	The name of the extension field.	test.com
BeforeDate	integer	The time when the certificate was issued.	2021-04-01 02:35:12
AfterDate	integer	The time when the certificate expires.	2021-04-01 02:35:12
Algorithm	string	The algorithm.	RSA
Issuer	string	The issuer.	Istio
GmtBefore	string	The time when the certificate was issued. The time is in GMT.	2021-04-01 02:35:12
GmtAfter	string	The time when the certificate expires. The time is in GMT.	2021-04-01 02:35:12
Http2	string	Specifies whether `HTTP/2` is enabled. Valid values: `open`: HTTP/2 is enabled. `close`: HTTP/2 is disabled. `globalConfig`: The global configuration is used.	close
TlsMax	string	The maximum Transport Layer Security (TLS) version.	TLS 1.3
TlsMin	string	The minimum TLS version.	TLS 1.0
IsManaged	boolean	Indicates whether the domain name is managed.

Examples

Success response

JSON format

{
  "RequestId": "88B83302-CD88-54D3-8DF2-208BFDC73F0D",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 403,
  "Success": true,
  "Data": {
    "Id": 12,
    "Name": "test.com",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597cd4a9****",
    "GatewayId": 1,
    "Protocol": "HTTP",
    "MustHttps": true,
    "CertIdentifier": "234-cn-hangzhou",
    "GmtCreate": "2022-01-07T10:07:57.000+0000",
    "GmtModified": "2022-01-07T10:07:57.000+0000",
    "CertName": "test",
    "CommonName": "name",
    "Sans": "test.com",
    "BeforeDate": 0,
    "AfterDate": 0,
    "Algorithm": "RSA",
    "Issuer": "Istio",
    "GmtBefore": "2021-04-01 02:35:12",
    "GmtAfter": "2021-04-01 02:35:12",
    "Http2": "close",
    "TlsMax": "TLS 1.3",
    "TlsMin": "TLS 1.0",
    "IsManaged": 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.