XCan Cloud

English

简体中文

English

简体中文

Appearance

Node​

Node Resource Management - Unified control plane for AngusTester server resource role allocation and monitoring

Replace the name of node​

PUT
/api/v1/node/{id}/name

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Node id

类型integer
必填
format"int64"

查询参数

name*

New node name

类型string
必填

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the list of node​

GET
/api/v1/node

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

id
类型integer
format"int64"
name
类型string
ip
类型string
source
类型string
枚举
"OWN_NODE""ONLINE_BUY"
role
类型string
枚举
"MANAGEMENT""CONTROLLER""EXECUTION""MOCK_SERVICE""APPLICATION"
enabled
类型boolean
tenantId
类型integer
format"int64"
orderId
类型integer
format"int64"
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
instanceExpiredDate
类型string
format"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

Page data size, default 10, maximum 2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
枚举
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

Filter value

infoScope

Query information scope

类型string
枚举
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Add nodes​

POST
/api/v1/node

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
[
{
"name": "node1",
"ip": "192.168.10.11",
"publicIp": "192.168.10.11",
"domain": "string",
"username": "root",
"password": "abc@123",
"sshPort": 0,
"roles": [
"string"
],
"tenantId": 1,
"free": 1
}
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Delete nodes​

DELETE
/api/v1/node

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

ids*

Node ids

类型array
必填
maxItems200
minItems0
uniqueItemstrue

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Update nodes​

PATCH
/api/v1/node

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
[
{
"id": 0,
"name": "node1",
"ip": "192.168.10.11",
"publicIp": "192.168.10.11",
"domain": "string",
"username": "root",
"password": "abc@123",
"sshPort": 22,
"roles": [
"string"
]
}
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Restart node agent​

POST
/api/v1/node/{id}/agent/restart

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Node id

类型integer
必填
format"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Install node agent​

POST
/api/v1/node/{id}/agent/install

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Node id

类型integer
必填
format"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Test node configuration​

POST
/api/v1/node/test

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"ip": "192.168.10.11",
"username": "root",
"password": "abc@123",
"sshPort": 22
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Purchase node​

POST
/api/v1/node/purchase

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"chargeType": "PostPaid",
"chargeCycle": 0,
"orderId": 10002929288887,
"free": true,
"cloudSupplier": "aliyun",
"regionId": "cn-shenzhen",
"nodeNum": 0,
"cpu": 8,
"memory": 16,
"sysDiskCategory": "cloud_essd",
"sysDisk": 200,
"bandwidthChargeType": "PayByTraffic",
"bandwidth": 1
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Stop Nodes​

PATCH
/api/v1/node/stop

Note: Only stopping purchased cloud nodes is supported

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

ids*
类型array
必填
maxItems200
minItems0
uniqueItemstrue

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Restart nodes​

PATCH
/api/v1/node/restart

Note: Only restart of purchased cloud nodes is supported

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

ids*
类型array
必填
maxItems200
minItems0
uniqueItemstrue

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Enable or disable nodes​

PATCH
/api/v1/node/enabled

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
[
{
"id": 1,
"enabled": true
}
]

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Query the detail of node​

GET
/api/v1/node/{id}

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Node id

类型integer
必填
format"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the mock service instances in the node​

GET
/api/v1/node/{id}/mock/service

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Node id

类型integer
必填
format"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Fulltext search the list of node​

GET
/api/v1/node/search

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

查询参数

id
类型integer
format"int64"
name
类型string
ip
类型string
source
类型string
枚举
"OWN_NODE""ONLINE_BUY"
role
类型string
枚举
"MANAGEMENT""CONTROLLER""EXECUTION""MOCK_SERVICE""APPLICATION"
enabled
类型boolean
tenantId
类型integer
format"int64"
orderId
类型integer
format"int64"
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
instanceExpiredDate
类型string
format"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

Page data size, default 10, maximum 2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
枚举
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

Filter value

infoScope

Query information scope

类型string
枚举
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}
授权
变量
键
值
cURL
JavaScript
PHP
Python

Query the number of node​

GET
/api/v1/node/count

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

tenantId
类型integer
format"int64"
source
类型string
枚举
"OWN_NODE""ONLINE_BUY"
enabled
类型boolean

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.

Copyright © 2021-2025 XCan Cloud