Download OpenAPI specification:Download
API for working with vDB Instances (Relational Databases, MemoryStore Databases and Kafka Clusters).
artifactId required | string |
portal-user-id required | integer <int32> |
product | string |
artifactType | string |
artifactId | string |
object (AutoRenewInfo) |
{- "product": "string",
- "artifactType": "string",
- "artifactId": "string",
- "autoRenewInfo": {
- "isEnable": true,
- "period": 0
}
}
instanceId required | string |
{- "dbInstanceId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "password": "S8oJRwAQ_hXH",
- "publicAccess": true,
- "backupAuto": true,
- "backupDuration": 2,
- "backupTime": "00:00"
}
instanceId required | string |
id | string |
direction | string |
etherType | string |
protocol | string |
portRangeMin | integer <int32> |
portRangeMax | integer <int32> |
remoteIpPrefix | string |
remoteGroupId | string |
remoteGroupName | string |
status | string |
description | string |
createdAt | string <date-time> |
displayCreatedAt | string |
[- {
- "id": "string",
- "direction": "string",
- "etherType": "string",
- "protocol": "string",
- "portRangeMin": 0,
- "portRangeMax": 0,
- "remoteIpPrefix": "string",
- "remoteGroupId": "string",
- "remoteGroupName": "string",
- "status": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "displayCreatedAt": "string"
}
]
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "databases": [
- {
- "name": "database-1",
- "characterSet": "utf8",
- "collate": "utf8_general_ci"
}
], - "user": {
- "name": "test",
- "password": "RB74qOoDxQ6D",
- "databases": [
- {
- "name": "database-1"
}
]
}, - "name": "database-lfduxavl-4t",
- "packageId": 135,
- "volumeSize": 20,
- "volumeType": "ssd-iops3000",
- "datastoreType": "MySQL",
- "datastoreVersion": "8.0",
- "netIds": [
- "sub-246df886-3ef8-4d70-87e7-6b87f0caea50"
], - "configId": "cfg-f42c6f8f-2cd1-4fcc-a27c-e06a23ca0c49",
- "publicAccess": true,
- "backupAuto": true,
- "backupDuration": 2,
- "backupTime": "00:00",
- "poc": true
}
resourceId required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "action": "renew",
- "databaseInstances": [
- {
- "instancesId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "config": {
- "resId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "resName": "database-1",
- "resType": "dbaas"
}
}
], - "resourceType": "dbaas"
}
instanceId required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "resourceType": "dbaas",
- "action": "resize",
- "databaseInstances": [
- {
- "instancesId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "config": {
- "volumeType": "ssd-iops3200",
- "volumeSize": 20,
- "poc": true
}
}
]
}
instanceId required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "resourceType": "dbaas",
- "action": "resize",
- "databaseInstances": [
- {
- "instancesId": "db-b0c9332f-96da-4aff-9439-38f9a9e2bf46",
- "config": {
- "packageId": 103,
- "poc": true
}
}
]
}
instanceId required | string |
{- "action": "delete",
- "databaseInstances": [
- {
- "instancesId": "db-270a92f0-bba6-4762-911a-44ebd66c0e66",
- "config": {
- "createFinalBackup": false,
- "deleteAllBackup": true
}
}
], - "resType": "dbaas"
}
instanceId required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "name": "database-g0viipgc-yh",
- "volumeSize": 20,
- "volumeType": "ssd-iops3000",
- "datastoreType": "MySQL",
- "datastoreVersion": "8.0",
- "netIds": [
- "sub-246df886-3ef8-4d70-87e7-6b87f0caea50"
], - "configId": "",
- "publicAccess": true,
- "backupAuto": true,
- "backupDuration": 2,
- "backupTime": "00:00",
- "packageId": "135",
- "replicaSourceId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "poc": true
}
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "action": "exchange_poc",
- "databaseInstances": [
- {
- "instancesId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "config": {
- "resId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "resName": "database-1",
- "resType": "dbaas"
}
}
], - "resourceType": "dbaas"
}
dbInstanceId required | string |
{- "dbInstanceId": "db-b0c9332f-96da-4aff-9439-38f9a9e2bf46",
- "redisPassword": "abcd1234abcd1234",
- "redisPasswordEnabled": true,
- "editRedisPassword": true,
- "publicAccess": false,
- "backupAuto": true,
- "backupDuration": 2,
- "backupTime": "00:00",
- "updateType": 0
}
dbInstanceId required | string |
{- "dbInstanceId": "db-b0c9332f-96da-4aff-9439-38f9a9e2bf46",
- "configId": "cfg-89bd25dc-79a5-49a8-9278-3ef0b23bba36",
- "updateType": 1
}
dbInstanceId required | string |
[- {
- "id": "98a148e4-8eb8-4aa5-a5a2-bcdbfd3b821b",
- "direction": "ingress",
- "etherType": "IPv4",
- "protocol": "tcp",
- "portRangeMin": 6379,
- "portRangeMax": 6379,
- "remoteIpPrefix": "10.11.0.0/16"
}, - {
- "direction": "ingress",
- "etherType": "IPv4",
- "protocol": "tcp",
- "portRangeMin": 6379,
- "portRangeMax": 6379,
- "remoteIpPrefix": "10.10.0.0/16"
}
]
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "backupAuto": false,
- "backupDuration": 2,
- "backupTime": "00:00",
- "configId": "",
- "datastoreType": "Redis",
- "datastoreVersion": "4.0",
- "name": "nhontt-mem-stg",
- "netIds": [
- "sub-c6071119-1a44-42cf-bc03-bb43e584242a"
], - "packageId": 102,
- "publicAccess": false,
- "redisPassword": "abcd1234abcd1234",
- "redisPasswordEnabled": true,
- "poc": true
}
dbInstanceId required | string |
{- "action": "start",
- "databaseInstances": [
- {
- "instancesId": "db-70a4fbee-db60-46d2-858c-875478a03a38"
}
], - "resType": "dbaas"
}
dbInstanceId required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "resourceType": "dbaas",
- "action": "resize",
- "databaseInstances": [
- {
- "instancesId": "db-b0c9332f-96da-4aff-9439-38f9a9e2bf46",
- "config": {
- "packageId": 103
}
}
]
}
dbInstanceId required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "action": "renew",
- "databaseInstances": [
- {
- "instancesId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "config": {
- "resId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "resName": "database-1",
- "resType": "dbaas"
}
}
], - "resourceType": "dbaas"
}
dbInstanceId required | string |
{- "action": "reboot",
- "databaseInstances": [
- {
- "instancesId": "db-70a4fbee-db60-46d2-858c-875478a03a38"
}
], - "resType": "dbaas"
}
dbInstanceId required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "action": "exchange_poc",
- "databaseInstances": [
- {
- "instancesId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "config": {
- "resId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "resName": "database-1",
- "resType": "dbaas"
}
}
], - "resourceType": "dbaas"
}
dbInstanceId required | string |
{- "action": "detach_replica",
- "databaseInstances": [
- {
- "instancesId": "db-70a4fbee-db60-46d2-858c-875478a03a38"
}
], - "resType": "dbaas"
}
dbInstanceId required | string |
{- "action": "delete",
- "databaseInstances": [
- {
- "instancesId": "db-270a92f0-bba6-4762-911a-44ebd66c0e66",
- "config": {
- "createFinalBackup": false,
- "deleteAllBackup": true
}
}
], - "resType": "dbaas"
}
dbInstanceId required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "backupAuto": false,
- "backupDuration": 2,
- "backupTime": "00:00",
- "configId": "",
- "datastoreType": "Redis",
- "datastoreVersion": "4.0",
- "name": "nhontt-mem-rep",
- "netIds": [
- "sub-ce1c9565-5abd-446c-ab46-3a9de7517e7a"
], - "packageId": "64",
- "publicAccess": false,
- "redisPasswordEnabled": false,
- "replicaSourceId": "db-ff53de54-f755-4b7e-8522-0cae12bd0fa9",
- "poc": true
}
{- "id": "cfg-1bbe18fb-8736-4307-a60d-f87e057c544c",
- "name": "redis40",
- "datastoreType": "Redis",
- "datastoreVersion": "4.0",
- "engineGroup": 2,
- "values": {
- "activedefrag": false,
- "appendonly": false
}
}
clusterId required | string |
userId required | string |
{- "produceTopicNames": [
- "string"
], - "produceAll": true,
- "consumeTopicNames": [
- "string"
], - "consumeAll": true,
- "mtlsAuthen": true,
- "saslAuthen": true
}
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
id | string |
name | string |
object | |
kafkaVersion | string |
serverFlavorId | string FlavorId |
kafkaBrokerCount | integer <int32> |
kafkaStorageType | string Volume Type KafkaUuid |
kafkaStorageSize | integer <int32> |
vserverProjectId | string |
networkId | string |
subnetId | string |
mtlsAuthen | boolean |
saslAuthen | boolean |
configGroupVersionId | string |
encryptionVolume | boolean |
{- "id": "string",
- "name": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "kafkaVersion": "string",
- "serverFlavorId": "string",
- "kafkaBrokerCount": 0,
- "kafkaStorageType": "string",
- "kafkaStorageSize": 0,
- "vserverProjectId": "string",
- "networkId": "string",
- "subnetId": "string",
- "mtlsAuthen": true,
- "saslAuthen": true,
- "configGroupVersionId": "string",
- "encryptionVolume": true
}
clusterId required | string |
{- "name": "string",
- "produceTopicNames": [
- "string"
], - "produceAll": true,
- "consumeTopicNames": [
- "string"
], - "consumeAll": true,
- "mtlsAuthen": true,
- "saslAuthen": true
}
portal-user-id required | integer <int32> |
resourceType required | stringdbaas|dbaas-backup-storage|kafka |
action required | stringcreate|create_kafka|resize_flavor|resize_volu... |
resourceInfo | object |
{- "resourceType": "string",
- "action": "string",
- "resourceInfo": { }
}
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "resourceType": "dbaas-backup-storage",
- "action": "resize",
- "databaseInstances": [
- {
- "instancesId": "db-bk-storage-a2579c3e-7a44-4d2d-9929-9da0e3cbf829",
- "config": {
- "backupPackageId": "3"
}
}
]
}
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "resourceType": "dbaas-backup-storage",
- "action": "renew",
- "databaseInstances": [
- {
- "instancesId": "db-bk-storage-c79b1cf3-8110-4553-9d45-5fe0241a0575",
- "config": {
- "resId": "db-bk-storage-c79b1cf3-8110-4553-9d45-5fe0241a0575",
- "resName": "relational_backup_storage"
}
}
]
}
id required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "resourceType": "dbaas-backup",
- "action": "restore_backup",
- "databaseInstances": [
- {
- "instancesId": "bk-f1018529-11d8-4aae-a733-e2ef6b0f40a8",
- "config": {
- "backupId": "bk-f1018529-11d8-4aae-a733-e2ef6b0f40a8",
- "name": "database-nw_yt603-wq",
- "volumeSize": 20,
- "datastoreType": "MySQL",
- "datastoreVersion": "8.0",
- "netIds": [
- "sub-246df886-3ef8-4d70-87e7-6b87f0caea50"
], - "configId": "cfg-f42c6f8f-2cd1-4fcc-a27c-e06a23ca0c49",
- "publicAccess": true,
- "backupAuto": true,
- "volumeType": "ssd-iops3000",
- "packageId": "103",
- "backupDuration": 2,
- "backupTime": "00:00",
- "poc": true
}
}
]
}
{- "name": "backup-bii5qju6-23",
- "dbInstanceId": "db-70a4fbee-db60-46d2-858c-875478a03a38",
- "backupType": "INCREMENTAL",
- "description": "Manual created",
- "engineGroup": 1,
- "parentId": "bk-e589fd8a-6037-47dc-95a2-338f209dc524"
}
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "resourceType": "dbaas-backup-storage",
- "action": "resize",
- "databaseInstances": [
- {
- "instancesId": "db-bk-storage-a2579c3e-7a44-4d2d-9929-9da0e3cbf829",
- "config": {
- "backupPackageId": "3"
}
}
]
}
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "resourceType": "dbaas-backup-storage",
- "action": "renew",
- "databaseInstances": [
- {
- "instancesId": "db-bk-storage-c79b1cf3-8110-4553-9d45-5fe0241a0575",
- "config": {
- "resId": "db-bk-storage-c79b1cf3-8110-4553-9d45-5fe0241a0575",
- "resName": "memory_store_backup_storage"
}
}
]
}
backupId required | string |
user-type | string Default: ROOT_USER Enum: "ROOT_USER" "IAM_USER" |
{- "resourceType": "dbaas-backup",
- "action": "restore_backup",
- "databaseInstances": [
- {
- "instancesId": "bk-2517476b-c555-43a7-8760-e9c0740b27bf",
- "config": {
- "backupId": "bk-2517476b-c555-43a7-8760-e9c0740b27bf",
- "name": "database-oi6enyek-1l",
- "datastoreType": "Redis",
- "datastoreVersion": "4.0",
- "netIds": [
- "sub-c6071119-1a44-42cf-bc03-bb43e584242a"
], - "configId": "",
- "publicAccess": false,
- "backupAuto": true,
- "volumeType": "ssd-iops200",
- "packageId": "102",
- "backupDuration": 2,
- "backupTime": "00:00",
- "redisPassword": "abcd1234abcd1234",
- "redisPasswordEnabled": true,
- "poc": true
}
}
]
}