ListVscs - Platform For AI - Alibaba Cloud Documentation Center

Queries a list of VSCs.

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

eflo:ListVscs

list

*Vsc

acs:eflo:{#regionId}:{#accountId}:vsc/*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token that marks the position from which to start the query. If you leave this parameter empty, the query starts from the beginning.	563d42ae0b17572449ec8c97f7f66069
MaxResults	integer	No	The maximum number of entries to return on each page.	20
NodeIds	array	No	The list of node IDs.
	string	No	A node ID.	['mock-sn-200101']
VscName	string	No	The name of the VSC.	test_name
Tag	array<object>	No	The list of tags.
	object	No	A tag.
Key	string	No	The tag key.	key001
Value	string	No	The tag value.	value001
ResourceGroupId	string	No	The ID of the resource group.	rg-aek2xdkc6icwfha

Response elements

Element	Type	Description	Example
	object	Schema of Response
TotalCount	integer	The total number of entries that match the query conditions.	3
RequestId	string	The ID of the request.	03668372-18FF-5959-98D9-6B36A4643C7A
NextToken	string	The token to retrieve the next page of results. If this parameter is empty, all results have been returned.	3a6b93229825ac667104463b56790c91
Vscs	array<object>	A list of VSCs.
	object	A VSC.
VscId	string	The ID of the VSC.	vsc-001
VscType	string	The type of the VSC. Valid values: `primary` and `standard`.	primary
VscName	string	The custom name of the VSC.	test_name
NodeId	string	The ID of the Lingjun node.	e01-cn-fzh47xd7u08
Status	string	The status of the VSC.	Normal
Tags	array<object>	The tags.
	object	A tag.
TagKey	string	The tag key.	key001
TagValue	string	The tag value.	value001
ResourceGroupId	string	The ID of the resource group.	rg-acfm2zkwhkns57i
MaxResults	integer	This parameter is not returned. Use the `TotalCount` parameter instead.	0

Examples

Success response

JSON format

{
  "TotalCount": 3,
  "RequestId": "03668372-18FF-5959-98D9-6B36A4643C7A",
  "NextToken": "3a6b93229825ac667104463b56790c91",
  "Vscs": [
    {
      "VscId": "vsc-001",
      "VscType": "primary",
      "VscName": "test_name",
      "NodeId": "e01-cn-fzh47xd7u08",
      "Status": "Normal",
      "Tags": [
        {
          "TagKey": "key001",
          "TagValue": "value001"
        }
      ],
      "ResourceGroupId": "rg-acfm2zkwhkns57i"
    }
  ],
  "MaxResults": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.