Download OpenAPI specification:Download
project_id required | string The project id |
endTime required | ref dd/MM/yyyy |
startTime required | ref dd/MM/yyyy |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/billing/statistics/projects/{project_id}/request', qs: {endTime: 'SOME_REF_VALUE', startTime: 'SOME_REF_VALUE'}, headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
endTime required | ref dd/MM/yyyy |
startTime required | ref dd/MM/yyyy |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/billing/statistics/projects/{project_id}/traffic', qs: {endTime: 'SOME_REF_VALUE', startTime: 'SOME_REF_VALUE'}, headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
endTime required | ref dd/MM/yyyy |
startTime required | ref dd/MM/yyyy |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/billing/statistics/projects/{project_id}/usage', qs: {endTime: 'SOME_REF_VALUE', startTime: 'SOME_REF_VALUE'}, headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/quota', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/traffic', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
endTime required | ref MM/dd/yyyy HH:mm |
startTime required | ref MM/dd/yyyy HH:mm |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/traffic/search', qs: {endTime: 'SOME_REF_VALUE', startTime: 'SOME_REF_VALUE'}, headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/usage', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
endTime required | ref MM/dd/yyyy HH:mm |
startTime required | ref MM/dd/yyyy HH:mm |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/usage/search', qs: {endTime: 'SOME_REF_VALUE', startTime: 'SOME_REF_VALUE'}, headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
user_id required | string The user portal id |
end_time required | ref MM/dd/yyyy HH:mm |
start_time required | ref MM/dd/yyyy HH:mm |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/users/{user_id}/usage', qs: {end_time: 'SOME_REF_VALUE', start_time: 'SOME_REF_VALUE'}, headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
limit | ref Example: limit=20 Page size |
marker | ref Last container name of previous page |
permission | ref Retrieve public (PUBLIC_READ) or private (PRIVATE_READ) containers |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}', qs: { limit: 'SOME_REF_VALUE', marker: 'SOME_REF_VALUE', permission: 'SOME_REF_VALUE' }, headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'POST', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/acls', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
req
Array of objects (UserRoleMapping) |
{- "userRoles": [
- {
- "roleName": "ContainerAdmin|ContainerViewer|ContainerReader|ContainerEditor",
- "userPortalId": 0
}
]
}
container required | string The container name |
project_id required | string The project id |
req
headers | Array of strings Value for the Access-Control-Allow-Headers header |
hosts | Array of strings Value for the Access-Control-Allow-Origin header |
{- "headers": [
- "string"
], - "hosts": [
- "string"
]
}
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/cors', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/public_access', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
req
enable required | boolean Allow public access to containers or not |
{- "enable": true
}
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'POST', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/static_web', headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/static_web', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/url', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
req
page required | integer <int32> |
pageSize required | integer <int32> |
searchNameOperator | string Search operator by name |
searchText | string |
{- "page": 0,
- "pageSize": 0,
- "searchNameOperator": "match_prefix|match_suffix|match_all|match_phrase",
- "searchText": "string"
}
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/{container}/details', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
directoryName | ref The directory name |
limit | ref Page size |
marker | ref Last object name of previous page |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}', qs: { directoryName: 'SOME_REF_VALUE', limit: 'SOME_REF_VALUE', marker: 'SOME_REF_VALUE' }, headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/directories', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
project_id required | string The project id |
req
directoryName required | string |
{- "directoryName": "string"
}
container required | string The container name |
directory required | string The directory name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/directories/{directory}', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
directory required | string The directory name |
project_id required | string The project id |
expiredTime required | ref The expired time of tempURL in second |
viewMode | ref Example: viewMode=view|download View or download with tempURL |
const request = require('request'); const options = { method: 'POST', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/directories/{directory}/download_tempurls', qs: {expiredTime: 'SOME_REF_VALUE', viewMode: 'SOME_REF_VALUE'}, headers: { accept: 'application/json', 'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
directory required | string The directory name |
project_id required | string The project id |
req
expiredTime required | integer <int64> The expired time of tempURL in second |
{- "expiredTime": 0
}
container required | string The container name |
project_id required | string The project id |
req
page required | integer <int32> |
pageSize required | integer <int32> |
searchBy required | string Search by name or tag |
searchNameOperator | string Search operator by name |
searchText | string |
{- "page": 0,
- "pageSize": 0,
- "searchBy": "name|tag",
- "searchNameOperator": "match_prefix|match_all|match_phrase|match_wildcard|match_regex",
- "searchText": "string"
}
container required | string The container name |
object required | string The object name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/objects/{object}', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
object required | string The object name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/objects/{object}/details', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
object required | string The object name |
project_id required | string The project id |
req
accessKey | string Required with URL type s3 |
secretKey | string Required with URL type s3 |
timeExpire required | integer <int64> The expired time of tempURL in second |
urlType | string URL type |
viewMode | string View or download with tempURL |
{- "accessKey": "string",
- "secretKey": "string",
- "timeExpire": 0,
- "urlType": "swift|s3",
- "viewMode": "view|download"
}
container required | string The container name |
object required | string The object name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/objects/{object}/metadata', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
object required | string The object name |
project_id required | string The project id |
req
required | object Map of metadata |
{- "metadata": {
- "string": "string"
}
}
container required | string The container name |
object required | string The object name |
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/containers/{container}/objects/{object}/tags', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
container required | string The container name |
object required | string The object name |
project_id required | string The project id |
req
tags required | Array of strings |
{- "tags": [
- "string"
]
}
container required | string The container name |
object required | string The object name |
project_id required | string The project id |
req
timeExpire required | integer <int64> The expired time of tempURL in second |
{- "timeExpire": 0
}
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
req
projectName required | string |
quotaInGBytes required | integer <int64> |
{- "projectName": "string",
- "quotaInGBytes": 0
}
project_id required | string The project id |
req
isEnable required | boolean Enable or disable project |
period | integer <int32> Select period to enable prepaid project |
{- "isEnable": true,
- "period": 0
}
project_id required | string The project id |
const request = require('request'); const options = { method: 'DELETE', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/details', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/projects/{project_id}/members', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
project_id required | string The project id |
req
quotaInGBytes required | integer <int64> |
{- "quotaInGBytes": 0
}
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/regions', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
region_id required | string The region id |
const request = require('request'); const options = { method: 'GET', url: 'http://hcm03-api.vstorage.vngcloud.vn/api/v1/regions/{region_id}', headers: {'content-type': '*/*', Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });