PullServices - Microservices Engine - Alibaba Cloud Documentation Center

Queries information about services that can be imported from a specified source.

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

get

*Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
SourceType	string	No	The type of the service source.	K8s
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-eccf313e2224438ba53d95d039e5****
Namespace	string	No	The namespace.	public
SourceId	integer	No	The service source ID	100
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.	EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2
HttpStatusCode	integer	The HTTP status code	200
Message	string	The returned message.	You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*
Code	integer	The response code.	200
Success	boolean	Indicates whether the call was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	array	The data returned.
	object	The data structure.
Namespace	string	The namespace.	default
GroupName	string	The group.	test
Services	array	The service list.
	object	The data structure.
Name	string	The service name.	test
Namespace	string	The namespace.	public
GroupName	string	The group.	test
SourceId	string	The source ID.	1
SourceType	string	The type of the source.	MSE
SourceIdList	array	The service source IDs.
	integer	The service source ID	100
SaeAppId	string
NamespaceShowName	string	The alias of the namespace.	public

Examples

Success response

JSON format

{
  "RequestId": "EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Namespace": "default",
      "GroupName": "test",
      "Services": [
        {
          "Name": "test",
          "Namespace": "public",
          "GroupName": "test",
          "SourceId": "1",
          "SourceType": "MSE",
          "SourceIdList": [
            100
          ],
          "SaeAppId": ""
        }
      ],
      "NamespaceShowName": "public"
    }
  ]
}

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.