ListConsumedServices-阿里云帮助中心

You can call the ListConsumedServices operation to retrieve a list of subscribed microservices.

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

sae:ListConsumedServices

get

*All Resource

*

None

Request syntax

GET /pop/v1/sam/service/listConsumedServices HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	b2a8a925-477a-4ed7-b825-d5e22500****

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. If the request is successful, success is returned. If the request fails, an error code is returned.	success
TraceId	string	The ID of the request trace. Use this ID to query the details of a request.	0a98a02315955564772843261e****
Data	array<object>	The information about the microservices.
	object	The information about the microservices.
Type	string	The type of the published service.	RPC
Groups	array	The groups to which the consumed services belong.
	string	The groups to which the consumed services belong.	HSF
Version	string	The version of the published service.	1.0.0
AppId	string	The application ID.	b2a8a925-477a-4ed7-b825-d5e22500****
Group2Ip	string	A reserved field.	{}
Ips	array	The service subscription addresses.
	string	The service subscription address.	10.0.0.1
Name	string	The name of the published service.	com.alibaba.nodejs.ItemService
ErrorCode	string	The error code. This parameter is not returned if the request is successful. This parameter is returned if the request fails. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code. 2xx: The request was successful. 3xx: The request was redirected. 4xx: A request error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the list of subscribed microservices was retrieved. true: The list was retrieved. false: The list failed to be retrieved.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "Type": "RPC",
      "Groups": [
        "HSF"
      ],
      "Version": "1.0.0",
      "AppId": "b2a8a925-477a-4ed7-b825-d5e22500****",
      "Group2Ip": "{}",
      "Ips": [
        "10.0.0.1"
      ],
      "Name": "com.alibaba.nodejs.ItemService"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.