All Products
Search

This Product

    Microservices Engine:GetMseSource

    Document Center

    Microservices Engine:GetMseSource

    Last Updated:Aug 28, 2026

    Queries MSE Nacos instances registered as service sources for a 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:GetMseSource

    get

    *Gateway

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    GatewayUniqueId

    string

    No

    The unique ID of the gateway.

    gw-7ea3da97b96543e19f6c597cd4a9****
    VpcId

    string

    No

    The VPC ID.

    vpc-bp1t50e045b5g7i3p****
    Type

    string

    No

    The MSE engine type. Valid values:

    • NACOS

    • ZOOKEEPER

    NACOS
    AcceptLanguage

    string

    No

    The language of the response. Valid values:

    • zh: Chinese

    • en: English

    Valid values:

    • en :
    • zh :

    zh

    Response elements

    Element

    Type

    Description

    Example

    object

    The data structure.

    RequestId

    string

    The request ID.

    5EB2D865-B43F-5526-8F92-857718CF73A2
    HttpStatusCode

    integer

    The HTTP status code.

    200
    Message

    string

    The response message.

    • If the request is successful, a success message is returned.

    • If the request fails, an error message is returned, such as the "TaskId not found" message.

    The request is successfully processed.

    Code

    integer

    The status code.

    1
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true
    Data

    array<object>

    The queried service sources.

    object

    The data structure.

    InstanceId

    string

    The instance ID.

    mse_prepaid_public_cn-7pp2eec****
    Address

    string

    The endpoint of the instance.

    mse-af1****-nacos-ans.mse.aliyuncs.com:8848
    Type

    string

    The service source type.

    Nacos
    Name

    string

    The service source name.

    test
    ClusterId

    string

    The cluster ID.

    mse_

    Examples

    Success response

    JSON format

    {
  "RequestId": "5EB2D865-B43F-5526-8F92-857718CF73A2",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 1,
  "Success": true,
  "Data": [
    {
      "InstanceId": "mse_prepaid_public_cn-7pp2eec****",
      "Address": "mse-af1****-nacos-ans.mse.aliyuncs.com:8848",
      "Type": "Nacos",
      "Name": "test",
      "ClusterId": "mse_"
    }
  ]
}

    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.