Call the UpdateServiceSource API to modify service sources of a cloud-native gateway - Microservices Engine - Alibaba Cloud - Microservices Engine

Modifies the service sources of a cloud-native gateway. Only Container Service for Kubernetes (ACK) service sources with Ingress resource monitoring configurations can be modified.

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

update

*Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	integer	No	The ID of the gateway.	429
Type	string	No	The type of the service source. Valid values: K8s: ACK cluster. NACOS: Nacos instance.	K8s
Source	string	No	The service source. Valid values: K8s: ACK cluster. MSE: Nacos instance.	K8s
Address	string	No	The address.	c9ad2a0717032427e920754e25b49e3b5
Id	integer	No	The ID of the service source.	63
Name	string	No	The name.	istio
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-cdd1bb9bfb8341e9805f931a3ba1f4c6
IngressOptionsRequest	object	No	The configurations of Ingress resources.	zh
EnableIngress	boolean	No	Whether to enable Ingress.	true
IngressClass	string	No	Whether to monitor Ingress classes.	com.test.xxx
WatchNamespace	string	No	The namespace whose resources you want to monitor.	default
EnableStatus	boolean	No	Whether to update the Ingress status.	true
PathList	array	No	An array of service root paths.
	string	No	The root path of the service.	/path
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.	6AB2B0B6-4A86-54E2-A340-FC47A22EE659
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	success
Code	integer	The response status code.	200
Success	boolean	Whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	integer	The response data.	63

Examples

Success response

JSON format

{
  "RequestId": "6AB2B0B6-4A86-54E2-A340-FC47A22EE659",
  "HttpStatusCode": 200,
  "Message": "success",
  "Code": 200,
  "Success": true,
  "Data": 63
}

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.