ListExternalServices-阿里云帮助中心

Operation description

This operation supports creating multiple services.

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

apig:ListExternalServices

none

*Gateway

acs:apig:{#regionId}:{#accountId}:gateway/{#GatewayId}

None

Request syntax

GET /v1/gateways/{gatewayId}/external-services HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
gatewayId	string	No	The gateway ID. Exact match.	gw-d76t026m1hkv70tla0e0

Request parameters

Parameter	Type	Required	Description	Example
sourceType	string	No	The service source type used to filter results. Valid values: MSE_NACOS: the service originates from MSE Nacos. K8s: the service originates from a Kubernetes cluster in Container Service. FC3: the service originates from Function Compute. VIP: the service originates from a fixed address. DNS: the service originates from a domain name.	FC3
limit	integer	No	The maximum number of entries to return. Valid range: (0, 100]. Default value: 10.	100
nameLike	string	No	Keyword for fuzzy matching by API name.	imah
importableOnly	boolean	No	Whether to return only services that have not been imported.	true
paiWorkspaceId	string	No	The workspace ID of the PAI-EAS service.	667435

Response elements

Element	Type	Description	Example
	object	Response schema.
requestId	string	The request ID.	D9B03B59-B2D6-51B0-A7E9-AF8466E320CA
code	string	The response code.	Ok
message	string	The response message.	Failed to upload data. Please try again
data	object	The list of APIs.
items	array<object>	The service information.
	array<object>	The zone ID.
namespace	string		PUBLIC
namespaceShowName	string		PUBLIC
services	array<object>
	object
name	string		enable-slash-merge
namespace	string		public

Examples

Success response

JSON format

{
  "requestId": "D9B03B59-B2D6-51B0-A7E9-AF8466E320CA",
  "code": "Ok",
  "message": "Failed to upload data. Please try again",
  "data": {
    "items": [
      {
        "namespace": "PUBLIC",
        "namespaceShowName": "PUBLIC",
        "services": [
          {
            "name": "enable-slash-merge",
            "namespace": "public"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.