Bind a Custom Domain to MSE Gateway via API - MSE - Alibaba Cloud - Microservices Engine

Modifies the associated domain name information.

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:UpdateGatewayDomain

update

*Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
Protocol	string	No	The protocol type. Valid values: HTTPS HTTP	HTTPS
MustHttps	boolean	No	Specifies whether to force HTTPS.	false
CertIdentifier	string	No	The certificate ID.	6209108-cn-hangzhou
Id	integer	Yes	The ID of the domain name to be updated.	94
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-86575c0bc9f04ecfbacb92b8e392****
Http2	string	No	Specifies whether to enable HTTP/2. Valid values: `open`: enables HTTP/2. `close`: disables HTTP/2. `globalConfig`: uses the global configuration.	close
TlsMax	string	No	The maximum TLS version.	TLS 1.3
TlsMin	string	No	The minimum TLS version.	TLS 1.0
TlsCipherSuitesConfigJSON	object	No	The TLS cipher suite configuration.
ConfigType	string	No	The cipher suite configuration type. Valid values: DEFAULT CUSTOM	DEFAULT
TlsCipherSuites	array	No	The list of cipher suite names.
	string	No	The cipher suite name.	ECDHE-RSA-AES128-GCM-SHA256
MtlsEnabled	boolean	No	Specifies whether to enable mTLS.
CaCertIdentifier	string	No	The CA certificate content.
AcceptLanguage	string	No	The language of the returned information. Valid values: zh: Chinese (default). en: English.	zh
EnableWaf	boolean	No	Specifies whether to enable Web Application Firewall (WAF) for the gateway domain name.

Response elements

Element	Type	Description	Example
	object	The data structure.
RequestId	string	The request ID.	6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	The request is processed successfully
Code	integer	The return code.	403
Success	boolean	The request result. Valid values: `true`: The request is successful. `false`: The request fails.	true
Data	integer	The returned data.	94

Examples

Success response

JSON format

{
  "RequestId": "6F6C6DE4-DB33-5791-B210-ED2E6FEFFE6F",
  "HttpStatusCode": 200,
  "Message": "The request is processed successfully.",
  "Code": 403,
  "Success": true,
  "Data": 94
}

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.