All Products
Search
Document Center

Microservices Engine:ImportServices

Last Updated:Aug 12, 2024

Imports services to a gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:ImportServicescreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ServiceListarray<object>No

The information about services.

DNS
objectNo

The data structure.

NamestringNo

The name of the service.

test
NamespacestringNo

The namespace.

public
GroupNamestringNo

The group.

test
IpsarrayNo

The IP addresses of the service.

stringNo

The IP address.

127.0.XX.XX
ServicePortlongNo

The port of the service.

8080
ServiceProtocolstringNo

The protocol of the service.

GRPC, HTTP
SourceTypestringYes

The service source. Valid values:

  • MSE: MSE Nacos instance
  • K8s: ACK cluster
  • VIP: fixed address
  • DNS: DNS domain
Enumeration Value:
  • EDAS: EDAS.
  • MSE_ZK: MSE_ZK.
  • SAE: SAE.
  • K8S: K8S.
  • DNS: DNS.
  • VIP: VIP.
  • MSE: MSE.
DNS
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-77e1153db6e14c0a8b1fae20bcb89ca5
TlsSettingstringNo

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" }
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

RequestIdstring

The ID of the request.

0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

The request is successfully processed.
Codeinteger

The status code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Databoolean

The result returned.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "0F0FBA7D-5AC5-5DC4-A1E9-E9656BFAE1B9",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": true
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-20The request parameters of the API has changedView Change Details
2023-03-07The request parameters of the API has changedView Change Details