UpdateGatewayService - Microservices Engine - Alibaba Cloud Documentation Center

Edit a gateway service (applicable only to fixed address services or DNS domain name services)

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

update

*Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	No	The service ID.	322
GatewayId	integer	No	The gateway ID.	501
Name	string	No	The service name. This parameter is deprecated and cannot be modified. The value of this parameter must be the same as the current service name.	test
IpList	array	No	The address list of fixed address services or domain name list of Domain Name System (DNS) services.
	string	No	The address of a fixed address service or domain name of a DNS service.	192.168.1.1:80
ServicePort	string	No	The service port. Specify this parameter for DNS services.	80
ServiceProtocol	string	No	The service protocol. HTTP HTTPS HTTP2 GRPC DUBBO	HTTP
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-c9bc5afd61014165bd58f621b491*****
TlsSetting	string	No	The Transport Layer Security (TLS) settings. Valid values: mode: TLS mode certId: certificate ID caCertId: CA certificate ID caCertContent: CA certificate public key sni: service name identification	{ "mode": "MUTUAL", "certId": "1*****-cn-hangzhou", "caCertContent": "123", "sni": "ceshi" }
DnsServerList	array	No	The list of Domain Name System (DNS) servers (for DNS domain name services only).
	string	No	The DNS server addresses (IP address+port number).	1.1.1.1:80
AcceptLanguage	string	No	The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.	zh

Response elements

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	AF21683A-29C7-4853-AC0F-B5ADEE4****
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	OK
Code	integer	The response code.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	integer	The service ID.	322

Examples

Success response

JSON format

{
  "RequestId": "AF21683A-29C7-4853-AC0F-B5ADEE4****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 322
}

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.