Download OpenAPI specification:Download
Api Documentation
| projectId required | string project id |
| name | string name |
| page | integer <int32> Default: 1 page |
| size | integer <int32> Default: 10 size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/dhcp_option', qs: {name: 'SOME_STRING_VALUE', page: '1', size: '10'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createDhcpOptionRequest
| dnsServers | Array of strings List of dns servers. |
| mtu | integer <int32> MTU Interface. |
| name required | string Name of the Dhcp Option |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "dnsServers": [
- "string"
], - "mtu": 1450,
- "name": "Dhcp Option A",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| id required | string The dhcp option id |
| projectId required | string project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/dhcp_option/%7Bid%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| id required | string The dhcp option id |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/dhcp_option/%7Bid%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| name | string name |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/elastic-ips', qs: { name: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string The project id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavors/customs', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string The project id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavors/customs/clusters', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| familyKey required | string The family key |
| platformKey required | string The platform key |
| project_id required | string The project id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavors/families/%7BfamilyKey%7D/platforms/%7BplatformKey%7D', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| familyKey required | string The family key |
| master required | boolean master |
| platformKey required | string The platform key |
| project_id required | string The project id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavors/families/%7BfamilyKey%7D/platforms/%7BplatformKey%7D/clusters/master/%7Bmaster%7D', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| flavor_id required | string flavor_id |
| project_id required | string project_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavors/%7Bflavor_id%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| flavor_zone_id required | string flavor_zone_id |
| project_id required | string project_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/%7Bflavor_zone_id%7D/flavors', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavor_zones/codes', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavor_zones/customs', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| master required | boolean master |
| project_id required | string project_id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavor_zones/customs/clusters/master/%7Bmaster%7D', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavor_zones/families', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavor_zones/families/clusters', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| product required | string product |
| project_id required | string project_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavor_zones/product', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| product required | string product |
| project_id required | string project_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavor_zones/product/%7Bproduct%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| flavor_zone_id required | string flavor_zone_id |
| project_id required | string project_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/flavor_zones/%7Bflavor_zone_id%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| page | integer <int32> page |
| serverId | string serverId |
| size | integer <int32> size |
| status | string status |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/histories/server-migration', qs: { page: 'SOME_INTEGER_VALUE', serverId: 'SOME_STRING_VALUE', size: 'SOME_INTEGER_VALUE', status: 'SOME_STRING_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/images/gpu', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/images/os', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/images/os_default', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string the project id |
| name | string name |
| page | integer <int32> Default: 1 page |
| size | integer <int32> Default: 10 size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/interconnects', qs: {name: 'SOME_STRING_VALUE', page: '1', size: '10'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createInterconnectRequest
| circuitId | integer <int32> circuitId |
| description | string Description |
| enableGw2 | boolean Enable Gw 2 |
| name required | string Name of the Interconnect |
| packageId required | string PackageId |
Array of objects (TagRequest) Tags of resource | |
| typeId required | string TypeId |
| zoneId | string Id of zone |
{- "circuitId": 4000,
- "description": "Interconnect from A to B",
- "enableGw2": true,
- "name": "Interconnect_01",
- "packageId": "itp-1Gbps",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "typeId": "EXTERNAL",
- "zoneId": "string"
}| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/interconnects/circuit-types', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project Id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/interconnects/packages', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| interconnectId required | string the interconnect id |
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/interconnects/%7BinterconnectId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| interconnectId required | string the interconnect id |
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateInterconnectRequest
| description | string Description |
| enableGw2 | boolean Enable Gw 2 |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "Interconnect from A to B",
- "enableGw2": true,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| interconnectId required | string the interconnect id |
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/interconnects/%7BinterconnectId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| interconnectId required | string the interconnect id |
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
changePackageInterconnectRequest
| packageId required | string PackageId |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "packageId": "itp-1Gbps",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| interconnectId required | string the interconnect id |
| projectId required | string the project id |
| name | string name |
| page | integer <int32> Default: 1 page |
| size | integer <int32> Default: 10 size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/interconnects/%7BinterconnectId%7D/connections', qs: {name: 'SOME_STRING_VALUE', page: '1', size: '10'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| interconnectId required | string the interconnect id |
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createInterconnectionRequest
| description | string Description |
| name required | string Name of the Interconnect Connection |
| networkId required | string net-657cf76c-cccc-xxxx-xxxx-5c8485578705 |
| subnets required | Array of strings List Remote Subnets |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "Connection from VPC A to B",
- "name": "Connection from A to B",
- "networkId": true,
- "subnets": [
- "10.21.10.0/24",
- "10.22.11.0/24"
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| interconnectId required | string the interconnect id |
| interconnectionId required | string the interconnection id |
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/interconnects/%7BinterconnectId%7D/connections/%7BinterconnectionId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| interconnectId required | string the interconnect id |
| interconnectionId required | string the interconnection id |
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateSubnetsInterconnectionRequest
| subnets required | Array of strings List Remote Subnets |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "subnets": [
- "10.21.10.0/24",
- "10.22.11.0/24"
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| interconnectId required | string the interconnect id |
| interconnectionId required | string the interconnection id |
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/interconnects/%7BinterconnectId%7D/connections/%7BinterconnectionId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| interconnectId required | string the interconnect id |
| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
pingInterconnectRequest
| gwNumber | integer <int32> Gateway Number (1 or 2) |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "gwNumber": 1,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string project id |
| name required | string name |
| page required | string Default: "1" page |
| size required | string Default: "10" size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/peering', qs: {name: 'SOME_STRING_VALUE', page: '1', size: '10'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| peeringId required | string peeringId |
| projectId required | string projectId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/peering/%7BpeeringId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/app-category', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| appInstanceUuid required | string app instance uuid |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/app-instance/%7BappInstanceUuid%7D', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| appCategoryId required | string app category id |
| appPackageId required | string app package id |
| appVersionUuid required | string app version uuid |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/app-package/%7BappCategoryId%7D/%7BappPackageId%7D/%7BappVersionUuid%7D', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| appTemplateId required | integer <int32> app template id |
| Authorization required | string Access Token |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/app-template/%7BappTemplateId%7D', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| all required | boolean all |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'POST', url: 'http://localhost:8080/v1/mp-migrate', qs: {all: 'SOME_BOOLEAN_VALUE'}, headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createNetworkAclRequest
| name required | string Name of The Network Acl table |
Array of objects (TagRequest) Tags of resource | |
| vpc required | string Uuid of The VPC |
| zoneId | string Id of zone |
{- "name": "Default",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "vpc": "net-7e9d494c-7127-48c8-8cd9-a954d37dfd65",
- "zoneId": "string"
}| projectId required | string The project id |
| name required | string name |
| page required | string Default: "1" page |
| size required | string Default: "10" size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/network-acl/list', qs: {name: 'SOME_STRING_VALUE', page: '1', size: '10'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| aclId required | string The network-acl uuid |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateAclRulesRequest
| aclId | string |
Array of objects (UpdatedAclPolicyRule) | |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "aclId": "string",
- "detailAclRuleList": [
- {
- "action": "string",
- "interfaceAclPolicyUuid": "string",
- "port": "string",
- "protocol": "string",
- "seqNumber": 0,
- "source": "string",
- "system": true,
- "type": "string"
}
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| networkAclUuid required | string The network-acl Uuid |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/network-acl/%7BnetworkAclUuid%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| uuid required | string The network-acl uuid |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/network-acl/%7Buuid%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| uuid required | string The network-acl uuid |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/network-acl/%7Buuid%7D/rules', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| uuid required | string The network-acl uuid |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateSubnetsRequest
| aclId | string aclId |
| subnetUuids | Array of strings The updated subnets uuid list of network-acl |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "aclId": "string",
- "subnetUuids": [
- "string"
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| dhcpOptionIds | Array of strings |
| encryptionTypes | Array of strings |
| ids | Array of strings |
| isCache | boolean |
| name | string |
| names | Array of strings |
| newTag.key | string |
| newTag.value | string |
| page | integer <int32> |
| privateIps | Array of strings |
| projectId | string |
| publicIps | Array of strings |
| resourceIds | Array of strings |
| serverIds | Array of strings |
| size | integer <int32> |
| status | Array of strings |
| subnetIds | Array of strings |
| tagIds | Array of strings |
| tags[0].key | string |
| tags[0].value | string |
| volumeTypes | Array of strings |
| vpcIds | Array of strings |
| zoneId | string |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/network-interfaces-elastic', qs: { dhcpOptionIds: 'SOME_ARRAY_VALUE', encryptionTypes: 'SOME_ARRAY_VALUE', ids: 'SOME_ARRAY_VALUE', isCache: 'SOME_BOOLEAN_VALUE', name: 'SOME_STRING_VALUE', names: 'SOME_ARRAY_VALUE', 'newTag.key': 'SOME_STRING_VALUE', 'newTag.value': 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', privateIps: 'SOME_ARRAY_VALUE', projectId: 'SOME_STRING_VALUE', publicIps: 'SOME_ARRAY_VALUE', resourceIds: 'SOME_ARRAY_VALUE', serverIds: 'SOME_ARRAY_VALUE', size: 'SOME_INTEGER_VALUE', status: 'SOME_ARRAY_VALUE', subnetIds: 'SOME_ARRAY_VALUE', tagIds: 'SOME_ARRAY_VALUE', 'tags[0].key': 'SOME_STRING_VALUE', 'tags[0].value': 'SOME_STRING_VALUE', volumeTypes: 'SOME_ARRAY_VALUE', vpcIds: 'SOME_ARRAY_VALUE', zoneId: 'SOME_STRING_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createNetworkInterfaceRequest
| floatingIpId | string |
| name required | string Name of network interface |
| securityGroupIds | Array of strings |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "floatingIpId": "string",
- "name": "network-interface",
- "securityGroupIds": [
- "string"
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| networkInterfaceId required | string The network interface id |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/network-interfaces-elastic/%7BnetworkInterfaceId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkInterfaceId required | string The network interface id |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/network-interfaces-elastic/%7BnetworkInterfaceId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkInterfaceId required | string The network interface id |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
renameNetworkInterfaceRequest
| name required | string Name of network interface |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "name": "network-interface",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string project id |
| dhcpOptionIds | Array of strings |
| encryptionTypes | Array of strings |
| ids | Array of strings |
| isCache | boolean |
| name | string |
| names | Array of strings |
| newTag.key | string |
| newTag.value | string |
| page | integer <int32> |
| privateIps | Array of strings |
| projectId | string |
| publicIps | Array of strings |
| resourceIds | Array of strings |
| serverIds | Array of strings |
| size | integer <int32> |
| status | Array of strings |
| subnetIds | Array of strings |
| tagIds | Array of strings |
| tags[0].key | string |
| tags[0].value | string |
| volumeTypes | Array of strings |
| vpcIds | Array of strings |
| zoneId | string |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/networks', qs: { dhcpOptionIds: 'SOME_ARRAY_VALUE', encryptionTypes: 'SOME_ARRAY_VALUE', ids: 'SOME_ARRAY_VALUE', isCache: 'SOME_BOOLEAN_VALUE', name: 'SOME_STRING_VALUE', names: 'SOME_ARRAY_VALUE', 'newTag.key': 'SOME_STRING_VALUE', 'newTag.value': 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', privateIps: 'SOME_ARRAY_VALUE', projectId: 'SOME_STRING_VALUE', publicIps: 'SOME_ARRAY_VALUE', resourceIds: 'SOME_ARRAY_VALUE', serverIds: 'SOME_ARRAY_VALUE', size: 'SOME_INTEGER_VALUE', status: 'SOME_ARRAY_VALUE', subnetIds: 'SOME_ARRAY_VALUE', tagIds: 'SOME_ARRAY_VALUE', 'tags[0].key': 'SOME_STRING_VALUE', 'tags[0].value': 'SOME_STRING_VALUE', volumeTypes: 'SOME_ARRAY_VALUE', vpcIds: 'SOME_ARRAY_VALUE', zoneId: 'SOME_STRING_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string projectId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createNetworkRequest
| cidr required | string Subnet of Network (/16). |
| name required | string Name of the Network |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "cidr": "10.2.0.0/16",
- "name": "Network_01",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string project id |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/networks/active', qs: {page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkId required | string networkId |
| projectId required | string projectId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/networks/%7BnetworkId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkId required | string networkId |
| projectId required | string projectId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/networks/%7BnetworkId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkId required | string networkId |
| projectId required | string projectId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateNetworkRequest
| name required | string Name of the Network |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "name": "Network_01",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| networkId required | string networkId |
| projectId required | string projectId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'PATCH', url: 'http://localhost:8080/v2/%7BprojectId%7D/networks/%7BnetworkId%7D/enableDns', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkId required | string networkId |
| projectId required | string projectId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateNetworkRequest
| dhcpOptionId required | string Dhcp Option Id |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "dhcpOptionId": "dop-xxxxx-xxxx-xxxx",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| name | string name |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/persistent-volumes', qs: { name: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| pvId required | string The persistent volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
deletePersistentVolumeBackendRequest
| forceDelete | boolean |
| persistentVolumeId | string |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "forceDelete": true,
- "persistentVolumeId": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/projects', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/projects/%7Bproject_id%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/protocols', headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/quotas/quotaUsed', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string projectId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/region', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string projectId |
| regionId required | string regionId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/region/%7BregionId%7D/users/validation', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string project id |
| name required | string name |
| page required | string Default: "1" page |
| size required | string Default: "10" size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/route-table', qs: {name: 'SOME_STRING_VALUE', page: '1', size: '10'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createReq
| name required | string Name of The route table |
| networkId required | string UUID of The VPC |
Array of objects (RouteRequest) List of routes for the Route Table | |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "name": "Default",
- "networkId": "net-7e9d494c-7127-48c8-8cd9-a954d37dfd65",
- "routes": [
- {
- "destinationCidrBlock": "192.168.1.0/24",
- "target": "192.168.1.1"
}
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string projectId |
| routeTableId required | string routeTableId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/route-table/route/%7BrouteTableId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string projectId |
| routeId required | string routeId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/route-table/%7BrouteId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string project id |
| uuid required | string The route-table uuid |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/route-table/%7Buuid%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| uuid required | string The route-table uuid |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
changeRoutesReq
Array of objects (RouteRequest) The updated routes list of route-table | |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "routes": [
- {
- "destinationCidrBlock": "192.168.1.0/24",
- "target": "192.168.1.1"
}
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string project id |
| dhcpOptionIds | Array of strings |
| encryptionTypes | Array of strings |
| ids | Array of strings |
| isCache | boolean |
| name | string |
| names | Array of strings |
| newTag.key | string |
| newTag.value | string |
| privateIps | Array of strings |
| projectId | string |
| publicIps | Array of strings |
| resourceIds | Array of strings |
| serverIds | Array of strings |
| status | Array of strings |
| subnetIds | Array of strings |
| tagIds | Array of strings |
| tags[0].key | string |
| tags[0].value | string |
| volumeTypes | Array of strings |
| vpcIds | Array of strings |
| zoneId | string |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/secgroups', qs: { dhcpOptionIds: 'SOME_ARRAY_VALUE', encryptionTypes: 'SOME_ARRAY_VALUE', ids: 'SOME_ARRAY_VALUE', isCache: 'SOME_BOOLEAN_VALUE', name: 'SOME_STRING_VALUE', names: 'SOME_ARRAY_VALUE', 'newTag.key': 'SOME_STRING_VALUE', 'newTag.value': 'SOME_STRING_VALUE', privateIps: 'SOME_ARRAY_VALUE', projectId: 'SOME_STRING_VALUE', publicIps: 'SOME_ARRAY_VALUE', resourceIds: 'SOME_ARRAY_VALUE', serverIds: 'SOME_ARRAY_VALUE', status: 'SOME_ARRAY_VALUE', subnetIds: 'SOME_ARRAY_VALUE', tagIds: 'SOME_ARRAY_VALUE', 'tags[0].key': 'SOME_STRING_VALUE', 'tags[0].value': 'SOME_STRING_VALUE', volumeTypes: 'SOME_ARRAY_VALUE', vpcIds: 'SOME_ARRAY_VALUE', zoneId: 'SOME_STRING_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createReq
| description | string description for secgroup. |
| name required | string Name of the Secgroup |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "string",
- "name": "Secgroup_01",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| secgroupId required | string The secgroup id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/secgroups/%7BsecgroupId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| secgroupId required | string The secgroup id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
editReq
| description | string description for secgroup. |
| name required | string Name of the Secgroup |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "string",
- "name": "Secgroup_01",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| secgroupId required | string The secgroup id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/secgroups/%7BsecgroupId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| secgroupId required | string The secgroup id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/secgroups/%7BsecgroupId%7D/secGroupRules', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| secgroupId required | string The secgroup id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/secgroups/%7BsecgroupId%7D/servers', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| secgroupId required | string Security Group Id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
req
| description | string Description for security group rule. |
| direction required | string "ingress" or "egress" |
| etherType required | string "IPv4" or "IPv6" |
| portRangeMax required | integer <int32> Upper bound of range port. |
| portRangeMin required | integer <int32> Lower bound of range port. |
| protocol required | string "TCP", "UDP", "ICMP", ... |
| remoteIpPrefix required | string Ip Prefix of source/target. |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "string",
- "direction": "egress",
- "etherType": "IPv4",
- "portRangeMax": 65335,
- "portRangeMin": 0,
- "protocol": "TCP",
- "remoteIpPrefix": "169.60.20.0/24",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/secgroups/%7BsecgroupId%7D/secgroupRules/samples', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| secgroupRuleId required | string secgroupRuleId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/secgroups/%7BsecgroupId%7D/secgroupRules/%7BsecgroupRuleId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| secgroupRuleId required | string The secgroup rule id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateSecurityGroupRuleRequest
| description | string Description for security group rule. |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| secgroupRuleId required | string The secgroup rule id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/secgroups/%7BsecgroupId%7D/secgroupRules/%7BsecgroupRuleId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string project id |
| name | string name |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/serverGroups', qs: {name: 'SOME_STRING_VALUE'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createServerGroupRequest
| description | string Description of server group |
| name required | string Name of the server group |
| policyId required | string Policy id of server group |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "This is my server group",
- "name": "Group-01",
- "policyId": "7916f5ac-cff2-11eb-b8bc-0242ac130003",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/serverGroups/policies', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverGroupId required | string The server group id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/serverGroups/%7BserverGroupId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverGroupId required | string The server group id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateServerGroupRequest
| description | string description for Server Group. |
| name required | string Name of the Server Group |
| serverGroupId required | string Id of the server group |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "string",
- "name": "Server Group_01",
- "serverGroupId": "Group-01",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverGroupId required | string The server group id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/serverGroups/%7BserverGroupId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| dhcpOptionIds | Array of strings |
| encryptionTypes | Array of strings |
| ids | Array of strings |
| isCache | boolean |
| name | string |
| names | Array of strings |
| newTag.key | string |
| newTag.value | string |
| page | integer <int32> |
| privateIps | Array of strings |
| projectId | string |
| publicIps | Array of strings |
| resourceIds | Array of strings |
| serverIds | Array of strings |
| size | integer <int32> |
| status | Array of strings |
| subnetIds | Array of strings |
| tagIds | Array of strings |
| tags[0].key | string |
| tags[0].value | string |
| volumeTypes | Array of strings |
| vpcIds | Array of strings |
| zoneId | string |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers', qs: { dhcpOptionIds: 'SOME_ARRAY_VALUE', encryptionTypes: 'SOME_ARRAY_VALUE', ids: 'SOME_ARRAY_VALUE', isCache: 'SOME_BOOLEAN_VALUE', name: 'SOME_STRING_VALUE', names: 'SOME_ARRAY_VALUE', 'newTag.key': 'SOME_STRING_VALUE', 'newTag.value': 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', privateIps: 'SOME_ARRAY_VALUE', projectId: 'SOME_STRING_VALUE', publicIps: 'SOME_ARRAY_VALUE', resourceIds: 'SOME_ARRAY_VALUE', serverIds: 'SOME_ARRAY_VALUE', size: 'SOME_INTEGER_VALUE', status: 'SOME_ARRAY_VALUE', subnetIds: 'SOME_ARRAY_VALUE', tagIds: 'SOME_ARRAY_VALUE', 'tags[0].key': 'SOME_STRING_VALUE', 'tags[0].value': 'SOME_STRING_VALUE', volumeTypes: 'SOME_ARRAY_VALUE', vpcIds: 'SOME_ARRAY_VALUE', zoneId: 'SOME_STRING_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createServerRequest
| attachFloating | boolean Attach floating IP |
| backupInstancePointId | string Backup instance point ID |
Array of objects (ConfigVolumeRestore) List Backup volume point Config | |
| createdFrom | string Created from: NEW, BACKUP, SNAPSHOT |
| dataDiskEncryptionType | string Type encryption of data volume |
| dataDiskName | string Name of data volume |
| dataDiskSize | integer <int32> |
| dataDiskTypeId | string ID of data volume type |
| enableBackup | boolean Enable backup: false, else: true |
| encryptionVolume required | boolean Encryption volume |
| expirePassword | boolean Skip change password: false, else: true |
| externalNetworkInterfaceId | string ID of the external network interface |
| flavorId required | string ID of the flavor |
| hostGroupId | string Host group. You can choose if having multiple host group |
| imageId required | string ID of the image |
| name required | string Name of the server |
| networkId required | string ID of the network |
Array of objects (NetworkRequest) List Network | |
| osLicence | boolean Licence of OS |
| poolName | string Name of the resource pool |
| product | string Product of server |
| rootDiskEncryptionType | string Type encryption of boot volume |
| rootDiskSize required | integer <int32> Size of boot volume |
| rootDiskTypeId required | string ID of boot volume type |
| securityGroup | Array of strings ID of the SecGroups |
| serverGroupId | string Server group ID |
| snapshotInstancePointId | string Snapshot instance point ID |
| sshKeyId | string ID of SSH key |
| subnetId required | string ID of the subnet |
Array of objects (TagRequest) Tags of resource | |
| type | string Type of product |
| userData | string User data |
| userDataBase64Encoded | boolean User data has already been base64 encoded |
| userName | string name of user |
| userPassword | string password of user |
| zoneId | string Id of zone |
{- "attachFloating": false,
- "backupInstancePointId": "string",
- "configVolumeRestores": [
- {
- "backupVolumePointId": "string",
- "snapshotVolumePointId": "string",
- "volumeId": "string",
- "volumeTypeId": "string"
}
], - "createdFrom": "NEW",
- "dataDiskEncryptionType": "aes-xts-plain64_256",
- "dataDiskName": "volume data",
- "dataDiskSize": 0,
- "dataDiskTypeId": "vtype-6d30737c-08aa-41f8-8bb1-d486c94ccf69",
- "enableBackup": true,
- "encryptionVolume": false,
- "expirePassword": true,
- "externalNetworkInterfaceId": "net-in-d1314dfd-31ac-4b5f-ad9a-a5a489ecfa5d",
- "flavorId": "flav-c41b827e-730a-475f-b181-c0d1c7acc6d4",
- "hostGroupId": "EB2690D8-D303-42B4-A083-DF170CEF7CA0",
- "imageId": "img-5c6639ad-8b02-4402-8be4-5bc0c6a57d32",
- "name": "Server_01",
- "networkId": "net-d1314dfd-31ac-4b5f-ad9a-a5a489ecfa5d",
- "networks": [
- {
- "attachFloating": true,
- "ip": "string",
- "networkId": "string",
- "projectId": "string",
- "subnetId": "string"
}
], - "osLicence": false,
- "poolName": "string",
- "product": "vServer",
- "rootDiskEncryptionType": "aes-xts-plain64_256",
- "rootDiskSize": 20,
- "rootDiskTypeId": "vtype-6d30737c-08aa-41f8-8bb1-d486c94ccf69",
- "securityGroup": [
- "secg-5c1e8e96-d106-4a91-8047-a76d1ae5ba9b"
], - "serverGroupId": "server-group-d4d6a036-1955-4c5f-a40d-e789d26cf49d",
- "snapshotInstancePointId": "string",
- "sshKeyId": "SSH_Key",
- "subnetId": "sub-b7716e75-10fa-4d18-9987-d68273f49386",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "type": "vServer",
- "userData": "string",
- "userDataBase64Encoded": true,
- "userName": "stackops",
- "userPassword": "password",
- "zoneId": "string"
}| interfaceNetworkInterfaceId required | string The interface network interface id |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/external-network-interfaces/%7BinterfaceNetworkInterfaceId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| subnetId required | string The subnet id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/subnets/%7BsubnetId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
deleteServerRequest
| deleteAllVolume | boolean Delete all volume are attached |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "deleteAllVolume": true,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/actions', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
completeMigrationRequest
| success | boolean |
{- "success": true
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/console-log', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/console-url', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
attachExternalNetworkInterfaceRequest
| externalNetworkInterfaceId | string External network interface id |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "externalNetworkInterfaceId": "net-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
detachExternalNetworkInterfaceRequest
| networkInterfaceId | string Network interface id |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "networkInterfaceId": "net-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
attachNetworkInterfaceRequest
Array of objects (AttachSubnetRequest) List subnet request | |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "subnetRequests": [
- {
- "ip": "10.1.1.5",
- "subnetId": "sub-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
detachNetworkInterfaceRequest
| networkInterfaceIds | Array of strings List Id of network interface |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "networkInterfaceIds": [
- "net-a332cc50-8e24-4a45-ad9f-4136c7358503"
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
attachNetworkInterfaceWithWanIpRequest
| ip | string IP of subnet |
| serverId | string Id of server |
| subnetId | string Id of subnet |
Array of objects (TagRequest) Tags of resource | |
| wanIpId | string Id of wan IP |
| zoneId | string Id of zone |
{- "ip": "10.1.1.5",
- "serverId": "ins-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "subnetId": "sub-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "wanIpId": "wan-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
detachNetworkInterfaceWithWanIpRequest
| networkInterfaceId | string List Id of network interface |
| serverId | string Id of server |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "networkInterfaceId": "net-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "serverId": "ins-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
migrateServerRequest
| action | string Action migrate. The action can be "SNAPSHOT" or "MIGRATE" or "CONFIRM-MIGRATE" |
| confirmMigrate | boolean Confirm migrate or rollback |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "action": "SNAPSHOT",
- "confirmMigrate": true,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/network-interfaces', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'PUT', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/reboot', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
renameServerRequest
| newName required | string New name of server |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "newName": "server01",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
resizeServerRequest
| flavorId required | string Id of flavor |
| hostGroupId | string Host group. You can choose if having multiple host group |
| serverId required | string Id of server |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "flavorId": "flav-c41b827e-730a-475f-b181-c0d1c7acc6d4",
- "hostGroupId": "EB2690D8-D303-42B4-A083-DF170CEF7CA0",
- "serverId": "ins-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/sec-groups', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createSnapshotServerRequest
| description required | string Description of the snapshot |
| enableSnapshot | boolean |
| name | string Name of the snapshot |
| snapshotPolicyId | string |
Array of objects (TagRequest) Tags of resource | |
| volumeIds | Array of strings |
| zoneId | string Id of zone |
{- "description": "Description",
- "enableSnapshot": true,
- "name": "snapshot_server",
- "snapshotPolicyId": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "volumeIds": [
- "string"
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/server-snapshots', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'PUT', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/server-snapshots/disable-auto', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'PUT', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/server-snapshots/enable-auto', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updatePolicySnapshotServerRequest
| snapshotPolicyId | string |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "snapshotPolicyId": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/snapshots', qs: {page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createSnapshotServerNowRequest
| description required | string Description of the snapshot |
| isPermanently | boolean Permanently or not |
| name required | string Name of the snapshot |
| retainedDays | integer <int32> Retained days of snapshot |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "Description",
- "isPermanently": false,
- "name": "snapshot_server",
- "retainedDays": 7,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/snapshots/detail', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| snapshotServerPointId required | string The snapshot server point id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
rollbackServerRequest
| restartServerWhenRevertCompleted | boolean |
| serverId | string |
| snapshotServerPointId | string |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "restartServerWhenRevertCompleted": true,
- "serverId": "string",
- "snapshotServerPointId": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| snapshotServerPointId required | string The snapshot server point id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/snapshots/%7BsnapshotServerPointId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'PUT', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/start', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'PUT', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/start-migrating', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'PUT', url: 'http://localhost:8080/v2/%7BprojectId%7D/servers/%7BserverId%7D/stop', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
changeSecGroupRequest
| securityGroup | Array of strings Id of the SecGroups |
| serverId required | string Id of server |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "securityGroup": [
- "secg-5c1e8e96-d106-4a91-8047-a76d1ae5ba9b"
], - "serverId": "ins-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| wanIpId required | string The wan ip id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
attachDetachWanIPRequest
| networkInterfaceId | string Id of network interface |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "networkInterfaceId": "net-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| wanIpId required | string The wan ip id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
attachDetachWanIPRequest
| networkInterfaceId | string Id of network interface |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "networkInterfaceId": "net-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string project id |
| name required | string name |
| page required | string Default: "1" page |
| size required | string Default: "10" size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/sshKeys', qs: {name: 'SOME_STRING_VALUE', page: '1', size: '10'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
req
| name required | string Name of the SSH key |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "name": "SSH_Key",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
importSSHKeyRequest
| name required | string Name of the SSH key |
| pubKey | string |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "name": "SSH_Key",
- "pubKey": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| sshKeyId required | string The ssh key id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/sshKeys/%7BsshKeyId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| sshKeyId required | string The ssh-key id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/sshKeys/%7BsshKeyId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkId required | string networkId |
| projectId required | string projectId |
| zoneId | string zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/networks/%7BnetworkId%7D/subnets', qs: {zoneId: 'SOME_STRING_VALUE'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkId required | string networkId |
| projectId required | string projectId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
req
| cidr required | string CIDR of Subnet, must be contained in its network. |
| name required | string Name of the Subnet |
Array of objects (CreateSecondarySubnetRequest) | |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "cidr": "10.2.12.0/24",
- "name": "Subnet_01",
- "secondarySubnetRequests": [
- {
- "cidr": "string",
- "name": "string",
- "uuid": "string"
}
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| networkId required | string networkId |
| projectId required | string projectId |
| subnetId required | string subnetId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/networks/%7BnetworkId%7D/subnets/%7BsubnetId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkId required | string networkId |
| projectId required | string projectId |
| subnetId required | string subnetId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/networks/%7BnetworkId%7D/subnets/%7BsubnetId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| networkId required | string networkId |
| projectId required | string projectId |
| subnetId required | string subnetId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateSubnetRequest
| name required | string Name of the subnet |
Array of objects (CreateSecondarySubnetRequest) | |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "name": "Subnet_01",
- "secondarySubnetRequests": [
- {
- "cidr": "string",
- "name": "string",
- "uuid": "string"
}
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| networkId required | string networkId |
| projectId required | string projectId |
| subnetId required | string subnetId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createSecondarySubnetRequest
| cidr | string |
| name | string |
| uuid | string |
{- "cidr": "string",
- "name": "string",
- "uuid": "string"
}| networkId required | string networkId |
| projectId required | string projectId |
| secondarySubnetId required | string secondarySubnetId |
| subnetId required | string subnetId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/networks/%7BnetworkId%7D/subnets/%7BsubnetId%7D/secondary-subnets/%7BsecondarySubnetId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| name | string name |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/tag', qs: { name: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/tag/quota', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| resourceId required | string The resource id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/tag/resource/%7BresourceId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| resourceId required | string The resource id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateTagRequest
| resourceId required | string Resource Id |
| resourceType required | string Resource Type |
Array of objects (TagRequest) List of Tag want to update | |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "resourceId": "ins-2ca9132c-bf4c-467e-b57c-92a971225947",
- "resourceType": "Server",
- "tagRequestList": [
- {
- "key": "test-key",
- "value": "test-value",
- "isSystemTag": "false"
}
], - "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string the project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/tag/tag-key', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| tagKey required | string The tag key |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/tag/tag-key/%7BtagKey%7D/tag-value', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| tagId required | string The tag id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/tag/%7BtagId%7D/resource-types/%7Bresource-types%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| name | string name |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/user-images', qs: { name: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createUserImageRequest
| name required | string Name of image |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "name": "image1",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| imageId required | string The image id |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/user-images/%7BimageId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| imageId required | string The image id |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/user-images/%7BimageId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createReq
| description | string description for Virtual IP Address. |
| ipAddress | string Ip address of the Virtual IP Address |
| mode | string |
| name required | string Name of the Virtual IP Address |
Array of objects (TagRequest) Tags of resource | |
| type required | string Enum: "public-vm" "public-mkp" Type of the Virtual IP Address |
| zoneId | string Id of zone |
{- "description": "string",
- "ipAddress": "192.168.1.2",
- "mode": "string",
- "name": "VIP Address 01",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "type": "public-vm or public-mkp",
- "zoneId": "string"
}| projectId required | string project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/public-vips/externalNetworkInterfaces', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| publicVipId required | string The public virtual ip address id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/public-vips/%7BpublicVipId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| virtualIpAddressId required | string The Virtual Ip Address id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
request
| networkInterfaceId required | string Id of the network interface |
{- "networkInterfaceId": "net-in-617fbb01-df70-4bd1-b7c7-8c848259cd5f"
}| addressPairId required | string The Address Pair id |
| projectId required | string The project id |
| virtualIpAddressId required | string The Virtual Ip Address id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/public-vips/%7BvirtualIpAddressId%7D/addressPairs/%7BaddressPairId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string project id |
| name required | string name |
| page required | string Default: "1" page |
| size required | string Default: "10" size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/virtualIpAddress', qs: {name: 'SOME_STRING_VALUE', page: '1', size: '10'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createReq
| description | string description for Virtual IP Address. |
| ipAddress | string Ip address of the Virtual IP Address |
| mode required | string Enum: "Active/Active" "Active/Passive" Mode of the Virtual IP Address |
| name required | string Name of the Virtual IP Address |
| subnetId required | string Id of the subnet |
{- "description": "string",
- "ipAddress": "192.168.1.2",
- "mode": "Active/Active",
- "name": "VIP Address 01",
- "subnetId": "sub-cfcd4f3f-4077-4923-9bf9-d19cb17f4f0b"
}| projectId required | string project id |
| subnetId | string subnetId |
| zoneId | string zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/virtualIpAddress/internalNetworkInterfaces', qs: {subnetId: 'SOME_STRING_VALUE', zoneId: 'SOME_STRING_VALUE'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| vipId required | string The virtual ip address id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/virtualIpAddress/%7BvipId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| virtualIpAddressId required | string The virtual Ip AddressId id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updateReq
| description | string description for Virtual IP Address. |
| mode required | string Enum: "Active/Active" "Active/Passive" Mode of the Virtual IP Address |
| name | string |
{- "description": "string",
- "mode": "Active/Active",
- "name": "string"
}| projectId required | string The project id |
| virtualIpAddressId required | string The virtual ip address id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/virtualIpAddress/%7BvirtualIpAddressId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| virtualIpAddressId required | string The Virtual Ip Address id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/virtualIpAddress/%7BvirtualIpAddressId%7D/addressPairs', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| virtualIpAddressId required | string The Virtual Ip Address id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createReq
| cidr | string |
| internalNetworkInterfaceId required | string Id of the network interface |
{- "cidr": "string",
- "internalNetworkInterfaceId": "net-in-617fbb01-df70-4bd1-b7c7-8c848259cd5f"
}| addressPairId required | string The Address Pair id |
| projectId required | string The project id |
| virtualIpAddressId required | string The Virtual Ip Address id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/virtualIpAddress/%7BvirtualIpAddressId%7D/addressPairs/%7BaddressPairId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| addressPairId required | string The Address Pair id |
| projectId required | string The project id |
| virtualIpAddressId required | string The Virtual Ip Address id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/virtualIpAddress/%7BvirtualIpAddressId%7D/addressPairs/%7BaddressPairId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| addressPairId required | string The Address Pair id |
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/virtual-subnets/addressPairs/%7BaddressPairId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| secondarySubnetId required | string The Secondary Subnet ID |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/virtual-subnets/%7BsecondarySubnetId%7D/addressPairs', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| secondarySubnetId required | string The Secondary Subnet ID |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createReq
| cidr | string |
| internalNetworkInterfaceId required | string Id of the network interface |
{- "cidr": "string",
- "internalNetworkInterfaceId": "net-in-617fbb01-df70-4bd1-b7c7-8c848259cd5f"
}| projectId required | string The project id |
| dhcpOptionIds | Array of strings |
| encryptionTypes | Array of strings |
| ids | Array of strings |
| isCache | boolean |
| name | string |
| names | Array of strings |
| newTag.key | string |
| newTag.value | string |
| page | integer <int32> |
| privateIps | Array of strings |
| projectId | string |
| publicIps | Array of strings |
| resourceIds | Array of strings |
| serverIds | Array of strings |
| size | integer <int32> |
| status | Array of strings |
| subnetIds | Array of strings |
| tagIds | Array of strings |
| tags[0].key | string |
| tags[0].value | string |
| volumeTypes | Array of strings |
| vpcIds | Array of strings |
| zoneId | string |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes', qs: { dhcpOptionIds: 'SOME_ARRAY_VALUE', encryptionTypes: 'SOME_ARRAY_VALUE', ids: 'SOME_ARRAY_VALUE', isCache: 'SOME_BOOLEAN_VALUE', name: 'SOME_STRING_VALUE', names: 'SOME_ARRAY_VALUE', 'newTag.key': 'SOME_STRING_VALUE', 'newTag.value': 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', privateIps: 'SOME_ARRAY_VALUE', projectId: 'SOME_STRING_VALUE', publicIps: 'SOME_ARRAY_VALUE', resourceIds: 'SOME_ARRAY_VALUE', serverIds: 'SOME_ARRAY_VALUE', size: 'SOME_INTEGER_VALUE', status: 'SOME_ARRAY_VALUE', subnetIds: 'SOME_ARRAY_VALUE', tagIds: 'SOME_ARRAY_VALUE', 'tags[0].key': 'SOME_STRING_VALUE', 'tags[0].value': 'SOME_STRING_VALUE', volumeTypes: 'SOME_ARRAY_VALUE', vpcIds: 'SOME_ARRAY_VALUE', zoneId: 'SOME_STRING_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createVolumeRequest
object (ConfigVolumeRestore) | |
| createdFrom | string Created from: NEW, BACKUP, SNAPSHOT |
| encryptionType | string Type encryption of volume |
| imageId | string Id of image |
| multiAttach | boolean Multi attach volume or not |
| name required | string Name of the volume |
| persistentVolume | boolean Persistent volume or not |
| poolName | string Name of the resource pool |
| size required | integer <int32> Size of volume |
Array of objects (TagRequest) Tags of resource | |
| volumeTypeId required | string Id of volume type |
| zoneId | string Id of zone |
{- "configVolumeRestore": {
- "backupVolumePointId": "string",
- "snapshotVolumePointId": "string",
- "volumeId": "string",
- "volumeTypeId": "string"
}, - "createdFrom": "NEW",
- "encryptionType": "aes-xts-plain64_256",
- "imageId": "img-6d30737c-08aa-41f8-8bb1-d486c94ccf69",
- "multiAttach": true,
- "name": "Volume",
- "persistentVolume": true,
- "poolName": "string",
- "size": 20,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "volumeTypeId": "vtype-6d30737c-08aa-41f8-8bb1-d486c94ccf69",
- "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/servers/%7BserverId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/servers/%7BserverId%7D/boot', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
changeTypeVolumeRequest
| action | string Action change type. The action can be "SNAPSHOT" or "MIGRATE" or "CONFIRM-MIGRATE" |
| confirmMigrate | boolean Confirm migrate or rollback |
Array of objects (TagRequest) Tags of resource | |
| volumeTypeId | string Id of volume type |
| zoneId | string Id of zone |
{- "action": "SNAPSHOT",
- "confirmMigrate": true,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "volumeTypeId": "vol-type-a332cc50-8e24-4a45-ad9f-4136c7358503",
- "zoneId": "string"
}| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D/history', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| volumeId required | string volumeId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D/mapping', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
renameVolumeRequest
| newName required | string New name of volume |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "newName": "volume",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
resizeVolumeRequest
| newSize required | integer <int32> New size of volume |
| newVolumeTypeId required | string Id of new volume type |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "newSize": 20,
- "newVolumeTypeId": "vtype-6d30737c-08aa-41f8-8bb1-d486c94ccf69",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
attachVolumeRequest
| persistentVolume | boolean Persistent volume or not |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "persistentVolume": true,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
detachVolumeRequest
| persistentVolume | boolean Persistent volume or not |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "persistentVolume": true,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| volumeId required | string The volume id |
| page | integer <int32> page |
| size | integer <int32> size |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D/snapshots', qs: {page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
createSnapshotVolumeNowRequest
| description required | string Description of the snapshot |
| isPermanently | boolean Permanently or not |
| name required | string Name of the snapshot |
| retainedDays | integer <int32> Retained days of snapshot |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "description": "Description",
- "isPermanently": false,
- "name": "snapshot_volume",
- "retainedDays": 7,
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| snapshotVolumePointId required | string The snapshot volume point id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
rollbackVolumeRequest
| restartServerWhenRevertCompleted | boolean |
| snapshotVolumePointId | string |
Array of objects (TagRequest) Tags of resource | |
| volumeId | string |
| zoneId | string Id of zone |
{- "restartServerWhenRevertCompleted": true,
- "snapshotVolumePointId": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "volumeId": "string",
- "zoneId": "string"
}| projectId required | string The project id |
| snapshotVolumePointId required | string The snapshot volume point id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D/snapshots/%7BsnapshotVolumePointId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D/volume-snapshots', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D/volume-snapshots/detail', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
updatePolicySnapshotVolumeRequest
| snapshotPolicyId | string |
Array of objects (TagRequest) Tags of resource | |
| zoneId | string Id of zone |
{- "snapshotPolicyId": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "zoneId": "string"
}| projectId required | string The project id |
| serverId required | string The server id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'PUT', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D/volume-snapshots/servers/%7BserverId%7D/disable-auto', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| serverId required | string The server id |
| volumeId required | string The volume id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'PUT', url: 'http://localhost:8080/v2/%7BprojectId%7D/volumes/%7BvolumeId%7D/volume-snapshots/servers/%7BserverId%7D/enable-auto', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/volume_default_id', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/volume_types', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| volume_type_id required | string volume_type_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/volume_types/%7Bvolume_type_id%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| volume_type_zone_id required | string volume_type_zone_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/%7Bvolume_type_zone_id%7D/volume_types', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| zoneId | string Default: "HCM03-1A" zoneId |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/volume_type_zones', qs: {zoneId: 'HCM03-1A'}, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| project_id required | string project_id |
| volume_type_zone_id required | string volume_type_zone_id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7Bproject_id%7D/volume_type_zones/%7Bvolume_type_zone_id%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string project id |
| dhcpOptionIds | Array of strings |
| encryptionTypes | Array of strings |
| ids | Array of strings |
| isCache | boolean |
| name | string |
| names | Array of strings |
| newTag.key | string |
| newTag.value | string |
| page | integer <int32> |
| privateIps | Array of strings |
| projectId | string |
| publicIps | Array of strings |
| resourceIds | Array of strings |
| serverIds | Array of strings |
| size | integer <int32> |
| status | Array of strings |
| subnetIds | Array of strings |
| tagIds | Array of strings |
| tags[0].key | string |
| tags[0].value | string |
| volumeTypes | Array of strings |
| vpcIds | Array of strings |
| zoneId | string |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v2/%7BprojectId%7D/wanIps', qs: { dhcpOptionIds: 'SOME_ARRAY_VALUE', encryptionTypes: 'SOME_ARRAY_VALUE', ids: 'SOME_ARRAY_VALUE', isCache: 'SOME_BOOLEAN_VALUE', name: 'SOME_STRING_VALUE', names: 'SOME_ARRAY_VALUE', 'newTag.key': 'SOME_STRING_VALUE', 'newTag.value': 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', privateIps: 'SOME_ARRAY_VALUE', projectId: 'SOME_STRING_VALUE', publicIps: 'SOME_ARRAY_VALUE', resourceIds: 'SOME_ARRAY_VALUE', serverIds: 'SOME_ARRAY_VALUE', size: 'SOME_INTEGER_VALUE', status: 'SOME_ARRAY_VALUE', subnetIds: 'SOME_ARRAY_VALUE', tagIds: 'SOME_ARRAY_VALUE', 'tags[0].key': 'SOME_STRING_VALUE', 'tags[0].value': 'SOME_STRING_VALUE', volumeTypes: 'SOME_ARRAY_VALUE', vpcIds: 'SOME_ARRAY_VALUE', zoneId: 'SOME_STRING_VALUE' }, headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| wanIpId required | string The WAN IP id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://localhost:8080/v2/%7BprojectId%7D/wanIps/%7BwanIpId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7BprojectId%7D/zones', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
| projectId required | string The project id |
| zoneId required | string The zone id |
| Authorization required | string Access Token |
| portal-user-id required | integer <int32> portal-user-id |
const request = require('request'); const options = { method: 'GET', url: 'http://localhost:8080/v1/%7BprojectId%7D/zones/%7BzoneId%7D', headers: { 'content-type': '*/*', Authorization: 'SOME_STRING_VALUE', 'portal-user-id': 'SOME_INTEGER_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });