Skip to main content

VKSList

更新时间:2025-05-07 17:32:25
Query the list of elastic container clusters for the current enterprise.
GET
https://api.alayanew.com/api/vks/v1/list
Authorizations
AuthorizationsStringHeaderRequired

用户可通过已获取Open API Key做验证,例如:plain Credential=[YOUR_AK],Signature=[YOUR_SK]。

Query Parameters
aidcIdString

AIDC ID (returns all if not provided).

nameString

Elastic container cluster name.

Response
状态码:application/json
codeInt

code is a common return value format, representing the execution result of the query operation

0 is a success identifier, indicating the operation completed successfully.
dataArray

Enumerates the detailed information of elastic container clusters.

data.idString

Elastic container cluster ID, e.g., vcgnci9viua1.

data.aidcIdInt

AIDC ID, e.g., 2.

data.nameString

Elastic container cluster name, e.g., vks003.

data.statusString

Elastic container cluster status, e.g., Running (Available), Paused (Stopped).

msgString

Returns error information when code is -1.

curl -X GET 'https://api.alayanew.com/api/vks/v1/list' 
     -H 'Authorization: plain Credential=YOUR_AK,Signature=YOUR_SK'
{
    "code": 0,
    "data": [
        {
            "name": "vks003",
            "id": "vcldkbd8xsiz",
            "aidcId": 4,
            "status": "Running"
        },
        {
            "name": "vxasd1",
            "id": "vcka6re1htzs",
            "aidcId": 4,
            "status": "Paused"
        },
        {
            "name": "vks0010111111",
            "id": "vcgnci9viua1",
            "aidcId": 2,
            "status": "Running"
        }
    ]
}