ListServiceSource - Microservices Engine - Alibaba Cloud Documentation Center

Queries a list of associated sources.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListServiceSource	get	*Gateway `acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}`	none	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 MSE MSE_ZK SAE EDAS	MSE
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The data structure.
RequestId	string	The ID of the request.	B8C4B0D8-EBB9-5F20-8295-04224FBE5529
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The error message returned.	You are not authorized to perform this operation.
Code	integer	The status code returned.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	array<object>	The returned data.
Sources	object	The data structure.
Id	long	The ID.	1
Name	string	The name.	test
Address	string	The ID of the Container Service for Kubernetes (ACK) cluster or the endpoint of the Microservices Engine (MSE) instance.	***
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 service source is associated with the gateway.	1
GatewayId	long	The ID of the gateway.	1
GmtCreate	string	The creation time.	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 information about the support for Ingresses by applications.
EnableIngress	boolean	Indicates whether Ingresses are enabled.	true
IngressClass	string	The Ingress class.	com.test.xxx
WatchNamespace	string	The namespace that you want to monitor.	default
EnableStatus	boolean	Indicates whether the Ingress status is updated.	true
GatewayUniqueId	string	The unique ID of the gateway.	gw-2u9uhd9283hd92hgd39g239dg2*****
GroupList	array	The array of service groups.
groupList	string	The group to which the service belongs.	DEFAULT_GROUP
PathList	array	The array of root paths of service lists.
pathList	string	The root path of the service list.	/path

Examples

Sample success responses

JSONformat

{
  "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"
      ]
    }
  ]
}

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
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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

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

Change history

Change time	Summary of changes	Operation
2023-10-12	The request parameters of the API has changed	View Change Details