ListServiceSource - Microservices Engine - Alibaba Cloud Documentation Center

Queries a list of associated sources.

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

get

*Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-c51a15c7ee934a4fb945ccf35fe1****
Source	string	No	Specifies the type of the returned service source. If this parameter is not specified, service sources of all types are returned. Valid values: K8s: Container Service for Kubernetes (ACK) instance. MSE Nacos: MSE MSE ZooKeeper: MSE_ZK SAE: SAE EDAS: EDAS	MSE
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	The data structure.
RequestId	string	The request ID.	B8C4B0D8-EBB9-5F20-8295-04224FBE5529
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message.	You are not authorized to perform this operation.
Code	integer	The response code.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	array	The returned result.
	object	The data structure.
Id	integer	The ID.	1
Name	string	The name.	test
Address	string	The ACK ID or MSE registry address.	***
Type	string	The type.	NACOS
Source	string	The type of the service source.	MSE
BindingWithGateway	integer	Indicates whether the service source is associated with the gateway. (The value 1 indicates that the association is complete)	1
GatewayId	integer	The gateway ID.	1
GmtCreate	string	The time when the environment was created.	2022-01-07 18:07:57
GmtModified	string	The update time.	2022-01-07 18:07:57
SourceUniqueId	string	The unique ID of the service source.	mse-cn-***
IngressOptions	object	The application routing Ingress support.
EnableIngress	boolean	Enables or disables Ingress.	true
IngressClass	string	The Ingress Class.	com.test.xxx
WatchNamespace	string	The namespace that you want to monitor.	default
EnableStatus	boolean	Indicates whether to update IngressStatus.	true
GatewayUniqueId	string	The unique ID of the gateway.	gw-2u9uhd9283hd92hgd39g239dg2*****
GroupList	array	The array of service groups.
	string	The service group.	DEFAULT_GROUP
PathList	array	The array of root paths of service lists.
	string	The root path of the service list.	/path
Invalid	boolean	Indicates whether the source is valid

Examples

Success response

JSON format

{
  "RequestId": "B8C4B0D8-EBB9-5F20-8295-04224FBE5529",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": 1,
      "Name": "test",
      "Address": "***",
      "Type": "NACOS",
      "Source": "MSE",
      "BindingWithGateway": 1,
      "GatewayId": 1,
      "GmtCreate": "2022-01-07 18:07:57",
      "GmtModified": "2022-01-07 18:07:57",
      "SourceUniqueId": "mse-cn-***",
      "IngressOptions": {
        "EnableIngress": true,
        "IngressClass": "com.test.xxx",
        "WatchNamespace": "default",
        "EnableStatus": true
      },
      "GatewayUniqueId": "gw-2u9uhd9283hd92hgd39g239dg2*****",
      "GroupList": [
        "DEFAULT_GROUP"
      ],
      "PathList": [
        "/path"
      ],
      "Invalid": 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.