Add Nacos Service Source via AddServiceSource API - Microservices Engine - Alibaba Cloud - Microservices Engine

Adds a Nacos service source.

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

create

*Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
Type	string	No	The type of the service source. K8s: Container Service for Kubernetes (ACK) cluster NACOS: Nacos instance	The Ingress configuration.
Source	string	No	The service source. K8s: ACK cluster NACOS: MSE Nacos instance	K8s,MSE
Address	string	No	Specifies whether to monitor Ingress classes.	c9ad2a0717032427e920754e25b49e3b5
Name	string	No	The namespace whose resources you want to monitor.	istio
GatewayUniqueId	string	Yes	Specifies whether to update the Ingress status.	gw-c70622ff52fe49beb29bea9a6f52****
IngressOptionsRequest	object	No	The list of service groups.
EnableIngress	boolean	No	The group to which the service belongs.	true
IngressClass	string	No	An array of service root paths.	com.test.xxx
WatchNamespace	string	No	The root path of the service.	default
EnableStatus	boolean	No	The language of the response. Valid values: zh-CN: Chinese. This is the default value. en-US: English. ja: Japanese.	true
ToAuthorizeSecurityGroups	array<object>	No	The security groups to authorize. Specify security groups to allow backend services to access the data sources you create.
	object	No
SecurityGroupId	string	No	The ID of the security group.	sg-bp1acepclex0vmi1****
PortRange	string	No	The authorized port range of the security group. Separate multiple port ranges with commas (,).	8080/8080,9000/10000
Description	string	No	The description of the authorization record.	rule for xxx
GroupList	array	No	The data structure.
	string	No	The ID of the request.	NACOS
PathList	array	No	The HTTP status code returned.
	string	No	The message returned.	/test
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN (default): Chinese en-US: English ja: Japanese	zh-CN

Response elements

Element	Type	Description	Example
	object	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.
RequestId	string	The response data.	D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA
HttpStatusCode	integer	code	200
Message	string	mse-200-105	You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7
Code	integer	duplicatedClusterAliasName	200
Success	boolean	duplicated cluster alias name	true
Data	integer	mse-100-007	63

Examples

Success response

JSON format

{
  "RequestId": "D0DB055C-51F2-5BB2-82A6-CD8A3C6EE6BA",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. Action: mse:AddServiceSource, Resource: acs:mse:cn-hangzhou:1105471854403716:instance/gw-082c943a8c304e48a37a7a29a5ddeda7",
  "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.