Enable Gateway Access by Subscribing to Imported Services - Microservices Engine - Alibaba Cloud - Microservices Engine

Subscribe to the services of the imported 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:ImportServices

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceList	array<object>	No	The service list.	DNS
	object	No	The data structure.
Name	string	No	The service name.	test
Namespace	string	No	The namespace.	public
GroupName	string	No	The group name.	test
Ips	array	No	The list of IP addresses.
	string	No	An IP address.	127.0.XX.XX
ServicePort	integer	No	The service port.	8080
ServiceProtocol	string	No	The service protocol.	GRPC, HTTP
DnsServerList	array	No	The list of DNS servers. This parameter is applicable only when `SourceType` is set to `DNS`.
	string	No	A DNS server address, specified in the `IP:port` format.	1.1.1.1:80
SaeAppId	string	No	The SAE application ID.
SourceType	string	Yes	The service source. Valid values: `MSE` (an MSE Nacos instance), `K8s` (an ACK container service), `VIP` (a fixed address), `DNS` (a DNS domain name), `EDAS` (an EDAS application), `SAE` (an SAE application), `FC` (a Function Compute service), and `MSE_ZK` (an MSE ZooKeeper instance). Valid values: EDAS : EDAS MSE_ZK : MSE_ZK SAE : SAE K8S : K8S DNS : DNS VIP : VIP MSE : MSE	DNS
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-77e1153db6e14c0a8b1fae20bcb89ca5
TlsSetting	string	No	The TLS settings, specified as a JSON string. The following fields are supported: `mode`: The TLS mode. `certId`: The certificate ID. `caCertId`: The CA certificate ID. `caCertContent`: The public key of the CA certificate. `sni`: The Server Name Indication (SNI).	{ "mode": "MUTUAL", "certId": "1*****-cn-hangzhou", "caCertContent": "123", "sni": "ceshi" }
FcServiceName	string	No	The name of the Function Compute (FC) service. This parameter is applicable only when `SourceType` is set to `FC`.	guide
FcVersion	string	No	The version of the FC service. This parameter is applicable only when `SourceType` is set to `FC`.	LATEST
FcAlias	string	No	The alias of the Function Compute (FC) service. This parameter is applicable only when `SourceType` is set to `FC`.	test-alias
SourceId	integer	No	The ID of the service source from which services are imported.	100
AcceptLanguage	string	No	The language of the response. Valid values: `zh`: Chinese `en`: English	zh

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	Succ
Code	integer	The response code.	200
Success	boolean	Indicates whether the request succeeded. Valid values: `true`: The request succeeded. `false`: The request failed.	true
Data	boolean	The returned data.	true

Examples

Success response

JSON format

{
  "RequestId": "0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9",
  "HttpStatusCode": 200,
  "Message": "Succ",
  "Code": 200,
  "Success": true,
  "Data": true
}

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.