huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20260619

{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"AvailabilityZoneDetail":{"description":"主备版的多AZ可用区详情","properties":{"primary_availability_zone":{"description":"**参数解释:**\n主可用区,应为单可用区且和备可用区不同。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"},"secondary_availability_zone":{"description":"**参数解释:**\n备可用区,应为单可用区且和主可用区不同。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"}},"required":["primary_availability_zone","secondary_availability_zone"]},"BackupStrategyOption":{"description":"高级备份策略。","properties":{"keep_days":{"description":"**参数解释:**\n指定已生成的备份文件可以保存的天数。\n**约束限制:**\n不涉及。\n**取值范围:**\n0~35。\n- 取0值,表示不设置自动备份策略。\n- 不传该参数,默认开启自动备份策略,备份文件默认保存7天。\n**默认取值:**\n7。","maximum":35,"minimum":0,"type":"integer"},"start_time":{"description":"**参数解释:**\n备份时间段。自动备份将在该时间段内触发。\n**约束限制:**\n非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。\n- HH取值必须比hh大1。\n- mm和MM取值必须相同,且取值必须为00、15、30或45。\n- 不传该参数,默认的备份时间段为00:00-01:00。\n- 取值示例:23:00-00:00。\n**取值范围:**\n不涉及。\n**默认取值:**\n默认的备份时间段为00:00-01:00。","example":"23:00-00:00","type":"string"}},"required":["start_time"]},"BackupStrategyResult":{"description":"高级备份策略,与请求参数相同。","properties":{"keep_days":{"description":"指定已生成的备份文件可以保存的天数。\n取值范围:0~35。\n  - 取0值,表示不设置自动备份策略。\n  - 不传该参数,默认开启自动备份策略,备份文件默认保存7天。","maximum":35,"minimum":0,"type":"string"},"start_time":{"description":"备份时间段。自动备份将在该时间段内触发。\n取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。\n  - HH取值必须比hh大1。\n  - mm和MM取值必须相同,且取值必须为00、30。\n  - 不传该参数,默认的备份时间段为00:00-01:00。\n  - 取值示例:23:00-00:00。","example":"23:00-00:00","type":"string"}}},"ChargeInfoOption":{"description":"计费类型信息,支持包年包月和按需计费,默认为按需计费。","properties":{"charge_mode":{"description":"**参数解释:**\n计费模式。\n**约束限制:**\n不涉及。\n**取值范围:**\n- prePaid:预付费,即包年/包月。\n- postPaid:后付费,即按需付费。\n**默认取值:**\n不涉及。","example":"prePaid","type":"string"},"is_auto_pay":{"description":"**参数解释:**\n创建包周期实例时可指定,表示是否自动从账户中支付,该字段不影响自动续订的支付方式。\n**约束限制:**\n不涉及。\n**取值范围:**\n- true,表示自动从账户中支付\n- false,表示手动从账户中支付,默认为该支付方式\n**默认取值:**\nfalse。","example":false,"type":"string"},"is_auto_renew":{"description":"**参数解释:**\n创建包周期实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。\n**约束限制:**\n不涉及。\n**取值范围:**\n- true,表示自动续订。\n- false,表示不自动续订,默认为该方式。\n**默认取值:**\nfalse。","example":true,"type":"string"},"period_num":{"description":"**参数解释:**\n指定订购的时间。\n**约束限制:**\n“charge_mode”为“prePaid”时生效,且为必选值。\n**取值范围:**\n- 当“period_type”为“month”时,取值为1~9。\n- 当“period_type”为“year”时,取值为1~3\n**默认取值:**\n不涉及。","example":1,"type":"string"},"period_type":{"description":"**参数解释:**\n订购周期类型。\n**约束限制:**\n“charge_mode”为“prePaid”时生效,且为必选值。\n**取值范围:**\n- month:包月。\n- year:包年。\n**默认取值:**\n不涉及。","example":"month","type":"string"}},"required":["charge_mode"]},"ChargeInfoResult":{"description":"付费方式信息,与请求参数相同。","properties":{"charge_mode":{"description":"计费模式。\n**取值范围:**\n  - prePaid:预付费,即包年/包月。\n  - postPaid:后付费,即按需付费。","example":"prePaid","type":"string"},"is_auto_pay":{"description":"创建包周期实例时可指定,表示是否自动从账户中支付,该字段不影响自动续订的支付方式。\n**取值范围:**\n  - true,表示自动从账户中支付\n  - false,表示手动从账户中支付,默认为该支付方式。","example":false,"type":"string"},"is_auto_renew":{"description":"创建包周期实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。\n**取值范围:**\n  - true,表示自动续订。\n  - false,表示不自动续订,默认为该方式。","example":true,"type":"string"},"period_num":{"description":"“charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。\n**取值范围:**\n  - 当“period_type”为“month”时,取值为1~9。\n  - 当“period_type”为“year”时,取值为1~3","example":1,"type":"string"},"period_type":{"description":"订购周期类型。\n“charge_mode”为“prePaid”时生效,且为必选值。\n**取值范围:**\n  - month:包月。\n  - year:包年。","example":"month","type":"string"}}},"CreateInstanceFlavorOption":{"description":"实例规格详情。","properties":{"num":{"description":"**参数解释:**\n节点数量。\n**约束限制:**\n不涉及。\n**取值范围:**\n- GeminiDB Cassandra实例的节点数量可取3~60。\n- GeminiDB Mongo 4.0版本副本集实例的节点数量为3。\n- GeminiDB Influx集群实例的节点数量可取3~16。\n- GeminiDB Influx单节点实例的节点数量可取1。\n- GeminiDB Redis实例的节点数量可取3~12。\n**默认取值:**\n不涉及。","type":"string"},"size":{"description":"**参数解释:**\n磁盘大小。必须为整数,单位为GB。\n**约束限制:**\nGeminiDB Cassandra,GeminiDB Mongo,GeminiDB Influx的最小磁盘容量100GB,最大磁盘容量与实例的性能规格有关。GeminiDB Redis的最大和最小磁盘容量与节点数和实例的性能规格有关。\n**取值范围:**\n- GeminiDB Cassandra请参见数据库实例规格。\n- GeminiDB Mongo请参见数据库实例规格。\n- GeminiDB Influx请参见数据库实例规格。\n- GeminiDB Redis请参见数据库实例规格。\n**默认取值:**\n不涉及。","type":"string"},"spec_code":{"description":"-| **参数解释:** 资源规格编码。 **约束限制:** 不涉及。 **取值范围:** 获取方法请参见查询数据库规格 - QueryingInstanceSpecifications中响应参数“spec_code”的值。 **默认取值:** 不涉及。","type":"string"},"storage":{"description":"**参数解释:**\n磁盘类型。\n**约束限制:**\n不涉及。\n**取值范围:**\n取值为“ULTRAHIGH”,表示SSD盘。\n**默认取值:**\n不涉及。","type":"string"}},"required":["num","size","storage","spec_code"]},"CreateInstanceFlavorResult":{"description":"实例规格详情,与请求参数相同。","properties":{"num":{"description":"节点数量。\n  - GeminiDB Cassandra实例的节点数量可取3~12。\n  - GeminiDB Mongo4.0版本副本集实例的节点数量可取3。\n  - GeminiDB Influx实例的节点数量可取3~16。","type":"string"},"size":{"description":"磁盘大小。必须为10的整数倍。单位为GB。最小磁盘容量100GB,最大磁盘容量与实例的性能规格有关,详见数据库实例规格。","type":"string"},"spec_code":{"description":"资源规格编码。获取方法请参见查询所有实例规格信息中响应参数“spec_code”的值。","type":"string"},"storage":{"description":"磁盘类型。\n取值为“ULTRAHIGH”,表示SSD盘。","type":"string"}}},"CreateInstanceRequestBody":{"description":"**参数解释:**\n'实例信息。'\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","properties":{"availability_zone":{"description":"**参数解释:**\n可用区ID。\n**约束限制:**\n不涉及。\n**取值范围:**\n取值:请参见查询所有实例规格信息中返回的“az_status” ,支持创建3可用区实例,中间以逗号隔开。\n**默认取值:**\n不涉及。","example":"az1","type":"string"},"availability_zone_detail":{"$ref":"#/definitions/AvailabilityZoneDetail","description":"**参数解释:**\n主备类型实例的多AZ可用区详情。\n**约束限制:**\n当选择单AZ部署时,自动忽略该参数设置。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。\n目前仅支持GeminiDB Redis实例。"},"backup_strategy":{"$ref":"#/definitions/BackupStrategyOption"},"charge_info":{"$ref":"#/definitions/ChargeInfoOption"},"configuration_id":{"description":"**参数解释:**\n'参数模板ID。'\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"},"datastore":{"$ref":"#/definitions/DatastoreOption","description":"**参数解释:**\n'数据库信息。'\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。"},"dedicated_resource_id":{"description":"**参数解释:**\n'专属资源ID。'\n**约束限制:**\n只有开通专属资源池后才可以下发此参数。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"},"disk_encryption_id":{"description":"**参数解释:**\n磁盘加密时的密钥ID,创建实例时不传该参数,表示不进行磁盘加密。\n**约束限制:**\n备份恢复新实例时不支持指定该参数,如果原实例使用了磁盘加密,新实例复用原实例加密的密钥ID。\n该参数仅GeminiDB influx 云原生部署模式集群增强版实例类型、GeminiDB Cassandra经典部署模式实例类型、GeminiDB兼容DynamoDB实例类型支持。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"},"enterprise_project_id":{"description":"**参数解释:**\n'企业项目ID。'\n**约束限制:**\n  -对于未开通企业多项目服务的用户,不传该参数。\n  -对于已开通企业多项目服务的用户,不传该参数时,表示为default企业项目。获取方式请参见《企业管理API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"},"flavor":{"description":"**参数解释:**\n实例规格详情。\n**约束限制:**\n获取方法请参见查询所有实例规格信息中响应“flavors”字段下参数的值。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","items":{"$ref":"#/definitions/CreateInstanceFlavorOption"},"type":"array"},"lb_access_control_settings":{"$ref":"#/definitions/LbAccessControlSettings","description":"**参数解释:**\n负载均衡访问控制配置。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。"},"mode":{"description":"**参数解释:**\n实例类型。\n**约束限制:**\n不涉及。\n**取值范围:**\n  -  GeminiDB Cassandra支持经典部署模式集群类型,取值为“Cluster”。\n  -  GeminiDB Cassandra支持云原生部署模式集群类型,取值“CloudNativeCluster”。\n  -  GeminiDB Mongo4.0版本支持副本集类型,取值为“ReplicaSet”。\n  -  GeminiDB Influx支持经典部署模式集群类型,取值为“Cluster”。\n  -  GeminiDB Influx支持云原生部署模式集群增强类型,取值为“CloudNativeCluster”。\n  -  GeminiDB Influx支持经典部署模式单节点类型,取值为“InfluxdbSingle”。\n  -  GeminiDB Influx支持经典部署模式集群增强类型,取值为“EnhancedCluster”。\n  -  GeminiDB Redis支持经典部署模式Proxy集群类型,取值为“Cluster”。\n  -  GeminiDB redis支持云原生部署模式集群类型,取值为“CloudNativeCluster”。\n  -  GeminiDB Redis支持经典部署模式Cluster集群类型,取值为“RedisCluster”\n  -  GeminiDB Redis支持经典部署模式主备类型,取值为“Replication”。\n  -  GeminiDB兼容DynamoDB支持经典部署模式集群类型,取值为“Cluster”。\n  -  GeminiDB兼容DynamoDB支持云原生部署模式集群类型,取值“CloudNativeCluster”。\n  -  GeminiDB HBase支持经典部署模式集群类型,取值为“Cluster”。\n  -  GeminiDB HBase支持云原生部署模式集群类型,取值“CloudNativeCluster”。\n**默认取值:**\n不涉及。","type":"string"},"name":{"description":"**参数解释:**\n实例名称,允许和已有名称重复。\n**约束限制:**\n区分大小写,可以包含字母、数字(0~9)、中划线(-)或者下划线(_),不能包含其他特殊字符。\n**取值范围:**\n长度为4~64位,必须以字母开头(A~Z或a~z)。\n**默认取值:**\n不涉及。","type":"string"},"password":{"description":"**参数解释:**\n数据库密码。\n**约束限制:**\n不涉及。\n**取值范围:**\n长度为8~32位,必须是大写字母(A~Z)、小写字母(a~z)、数字(0~9)、特殊字符~!@#%^*-_=+?的组合。建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。\n**默认取值:**\n不涉及。","type":"string"},"port":{"description":"**参数解释:**\n数据库访问端口号。\n**约束限制:**\n目前仅支持GeminiDB\nRedis实例支持自定义端口,取值范围为:1024~65535,禁用端口号为:2180、2887、3887、6377、6378、6380、8018、8079、8091、8479、8484、8999、12017、12333、50069。\n\n不指定端口时,创建GeminiDB Redis实例的访问端口默认为6379。\n\n如果该实例计划用于搭建双活容灾场景,请配置为8635端口。\n**取值范围:**\n取值范围为:1024~65535,禁用端口号为:2180、2887、3887、6377、6378、6380、8018、8079、8091、8479、8484、8999、12017、12333、50069。\n**默认取值:**\n6379。","type":"string"},"product_type":{"description":"**参数解释:**\n产品类型。\n**约束限制:**\n当创建GeminiDB Redis云原生部署模式集群类型必传此参数。\n**取值范围:**\n- Capacity 容量型\n**默认取值:**\n不涉及。","type":"string"},"region":{"description":"**参数解释:**\n区域ID。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n非空。","type":"string"},"restore_info":{"$ref":"#/definitions/RestoreInfo"},"security_group_id":{"description":"**参数解释:**\n安全组ID。\n**约束限制:**\n不涉及。\n**取值范围:**\n 获取方法如下:\n  - 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。\n  - 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询安全组列表。\n**默认取值:**\n不涉及。","type":"string"},"ssl_option":{"description":"**参数解释:**\nSSL开关选项。\n**约束限制:**\n不涉及。\n**取值范围:**\n- 取“0”,表示DDS实例默认不启用SSL连接。\n- 取“1”,表示DDS实例默认启用SSL连接。\n- 不传该参数时,默认不启用SSL连接。\n**默认取值:**\n不涉及。","type":"string"},"subnet_id":{"description":"**参数解释:**\n子网的网络ID。\n**约束限制:**\n不涉及。\n**取值范围:**\n 获取方法如下:\n  - 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。\n  - 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表。\n**默认取值:**\n不涉及。","type":"string"},"vpc_id":{"description":"**参数解释:**\n虚拟私有云ID。\n**约束限制:**\n 获取方法如下:\n  - 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。\n  - 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询VPC列表。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"}},"required":["name","datastore","region","availability_zone","vpc_id","subnet_id","security_group_id","password","mode","flavor"]},"CreateInstanceResponseBody":{"properties":{"availability_zone":{"description":"可用区ID,与请求参数相同。","example":"az1","type":"string"},"backup_strategy":{"$ref":"#/definitions/BackupStrategyResult","description":"高级备份策略,与请求参数相同。"},"charge_info":{"$ref":"#/definitions/ChargeInfoResult"},"created":{"description":"创建时间为本地时间,格式为“yyyy-mm-dd hh:mm:ss”。","type":"string"},"datastore":{"$ref":"#/definitions/DatastoreResult","description":"数据库信息,与请求参数相同。"},"dedicated_resource_id":{"description":"专属资源ID,只有创建在专属资源上的实例才会返回该字段。","type":"string"},"enterprise_project_id":{"description":"企业项目ID。取值为“0”,表示为default企业项目。","type":"string"},"flavor":{"description":"实例规格详情,与请求参数相同。","items":{"$ref":"#/definitions/CreateInstanceFlavorResult"},"type":"array"},"id":{"description":"实例ID。","type":"string"},"job_id":{"description":"创建实例的任务ID, 仅创建按需实例时会返回该参数。","type":"string"},"mode":{"description":"实例类型,与请求参数相同。","type":"string"},"name":{"description":"实例名称,与请求参数相同。","type":"string"},"order_id":{"description":"创建实例的订单ID,仅创建包年包月时返回该参数。","type":"string"},"region":{"description":"区域ID,与请求参数相同。","type":"string"},"security_group_id":{"description":"实例所属的安全组ID,与请求参数相同。","type":"string"},"ssl_option":{"description":"SSL开关选项,与请求参数相同。","type":"string"},"status":{"description":"实例状态,取值为“creating”。","type":"string"},"subnet_id":{"description":"子网ID,与请求参数相同。","type":"string"},"vpc_id":{"description":"虚拟私有云ID,与请求参数相同。","type":"string"}}},"DatastoreOption":{"properties":{"storage_engine":{"description":"**参数解释:**\n存储引擎。\n**约束限制:**\n不涉及。\n**取值范围:**\n- GeminiDB Cassandra实例支持RocksDB存储引擎,取值为“rocksDB”。\n- GeminiDB Mongo实例支持RocksDB存储引擎,取值为“rocksDB”。\n- GeminiDB Influx实例支持RocksDB存储引擎,取值为“rocksDB”。\n- GeminiDB Redis实例支持RocksDB存储引擎,取值为“rocksDB”。\n**默认取值:**\n不涉及。","type":"string"},"type":{"description":"**参数解释:**\n数据库类型。\n**约束限制:**\n支持GeminiDB Cassandra、GeminiDB Mongo、GeminiDB Influx和GeminiDB Redis数据库实例。\n**取值范围:**\n- 取值为“cassandra”,表示创建GeminiDB Cassandra数据库实例。\n- 取值为“mongodb”,表示创建GeminiDB Mongo数据库实例。\n- 取值为“influxdb”,表示创建GeminiDB Influx数据库实例。\n- 取值为“redis”,表示创建GeminiDB Redis数据库实例。\n- 取值为“dynamodb”,表示创建GeminiDB兼容DynamoDB数据库实例。\n- 取值为“hbase”,表示创建GeminiDB HBase数据库实例。\n**默认取值:**\n不涉及。","type":"string"},"version":{"description":"**参数解释:**\n数据库版本。\n**约束限制:**\n- GeminiDB Cassandra实例支持3.11版本,取值为“3.11”。\n- GeminiDB Mongo实例支持4.0版本,取值为4.0\"。\n- GeminiDB Influ经典部署模式集群类型实例支持1.8版本,取值为“1.8”。\n- GeminiDB Influx云原生部署模式集群类型实例支持1.7版本,取值为“1.7”。\n- GeminiDB Redis实例支持5.0版本,取值为“5.0”。\n- GeminiDB DynamoDB实例取值为“”。\n- GeminiDB HBase实例取值为“”。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"}},"required":["type","version","storage_engine"]},"DatastoreResult":{"description":"数据库信息,与请求参数相同。","properties":{"storage_engine":{"description":"存储引擎。\n- GeminiDB Cassandra实例支持RocksDB存储引擎,取值为“rocksDB”。\n- GeminiDB Mongo实例支持RocksDB存储引擎,取值为“rocksDB”。\n- GeminiDB Influx实例支持RocksDB存储引擎,取值为“rocksDB”。","type":"string"},"type":{"description":"数据库类型。\n- 支持GeminiDB Cassandra,GeminiDB Mongo,GeminiDB Influx数据库实例。\n- 取值为“cassandra”,表示创建GeminiDB Cassandra数据库实例。\n- 取值为“mongodb”,表示创建GeminiDB Mongo数据库实例。\n- 取值为“influxdb”,表示创建GeminiDB Influx数据库实例。\n- 取值为“dynamodb”,表示创建GeminiDB DynamoDB数据库实例。\n- 取值为“hbase”,表示创建GeminiDB Hbase数据库实例。","type":"string"},"version":{"description":"数据库版本。\n- GeminiDB Cassandra实例支持3.11版本,取值为“3.11”。\n- GeminiDB Mongo实例支持3.4,4.0版本,取值为\"3.4\"或\"4.0\"。\n- GeminiDB Influx实例支持1.7版本,取值为“1.7”。\n- GeminiDB DynamoDB取值为“”。\n- GeminiDB HBase取值为“”。","type":"string"}}},"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"IpGroupsDetail":{"description":"**参数解释:**\nIP地址组中包含的IP或网段列表。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","properties":{"description":{"description":"**参数解释:**\n备注信息。\n**约束限制:**\n最长255字符。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","example":"some description","maxLength":255,"type":"string"},"ip":{"description":"**参数解释:**\nIP地址或网段。\n**约束限制:**\n支持IPv4。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","example":"123.123.123.0/24","type":"string"}},"required":["ip","description"]},"LbAccessControlSettings":{"description":"**参数解释:**\n负载均衡访问控制配置。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","properties":{"enabled":{"description":"**参数解释:**\n是否开启负载均衡访问控制。\n**约束限制:**\n不涉及。\n**取值范围:**\n -true。\n -false。\n**默认取值:**\n不涉及。","enum":[true,false],"type":"boolean"},"ip_groups":{"description":"**参数解释:**\nIP地址组中包含的IP或网段列表。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","items":{"$ref":"#/definitions/IpGroupsDetail"},"type":"array"},"type":{"description":"**参数解释:**\n黑白名单类型。\n**约束限制:**\n仅支持设置黑名单或白名单中的一种,当配置切换时,原配置会失效。\n**取值范围:**\n -blackList黑名单\n -whiteList白名单。\n**默认取值:**\n不涉及。","enum":["blackList","whiteList"],"type":"string"}},"required":["enabled","type","ip_groups"]},"RestoreInfo":{"description":"**参数解释:**\n备份信息。\n**约束限制:**\n支持按指定备份恢复和按指定实例的指定时间点恢复。\n目前仅GeminiDB Cassandra和GeminiDB Influx集群支持按指定实例的指定时间点恢复。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","properties":{"backup_id":{"description":"**参数解释:**\n全量备份文件ID。\n**约束限制:**\n用于根据指定备份恢复数据到一个新创建的实例的场景,此场景下该字段取值不能为空。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"},"restore_time":{"description":"**参数解释:**\n数据恢复的指定的时间点。\n**约束限制:**\n用于恢复指定实例的指定时间点的数据到一个新创建的实例的场景,此场景下该字段取值不能为空。\n**取值范围:**\n取值为UTC 13位毫秒数,可通过查询实例可恢复的时间段 - QueryingtheTimeWindowWhenaBackupCanBeRestored接口进行查询。\n**默认取值:**\n不涉及。","format":"int64","type":"integer"},"source_instance_id":{"description":"**参数解释:**\n数据恢复参考的指定实例的ID。\n**约束限制:**\n用于恢复指定实例的指定时间点的数据到一个新创建的实例的场景,此场景下该字段取值不能为空。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","type":"string"}},"type":"object"}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"b5c0efe63c544cbb948627c792ec4a15","info_version":"v3","method":"post","name":"CreateInstance","parameters":{},"paths":{"/v3/{project_id}/instances":{"post":{"description":"创建数据库实例。","operationId":"CreateInstance","parameters":[{"description":"**参数解释:**\n用户Token。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"******"},{"description":"**参数解释:**\n租户在某一region下的project ID。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"请求体。","in":"body","name":"CreateInstanceRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateInstanceRequestBody"}}],"responses":{"202":{"description":"Success.","examples":{"application/json":{"availability_zone":"bbb","backup_strategy":{"keep_days":"8","start_time":"08:15-09:15"},"created":"2019-01-16 09:34:36","datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"disk_encryption_id":"2gfdsh-844a-4023-a776-fc5c5fb71fb4","enterprise_project_id":"0","flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"id":"39b6a1a278844ac48119d86512e0000bin06","job_id":"c010abd0-48cf-4fa8-8cbc-090f093eaa2f","mode":"Cluster","name":"test-cassandra-01","region":"aaa","security_group_id":"2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5","ssl_option":"1","status":"creating","subnet_id":"0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f","vpc_id":"490a4a08-ef4b-44c5-94be-3051ef9e4fce"}},"schema":{"$ref":"#/definitions/CreateInstanceResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"创建实例","tags":["实例管理"],"x-constraint":"[该接口支持如下数据库实例:]\n  - [GeminiDB Cassandra]\n  - [GeminiDB Mongo]\n  - [GeminiDB Influx]\n  - [GeminiDB Redis]\n  - [GeminiDB HBase]\n  - [GeminiDB 兼容DynamoDB]\n\n该接口既支持包周期实例,也支持按需实例。\n\n恢复指定实例的指定时间点的数据到一个新创建的实例仅支持GeminiDB Cassandra和GeminiDB Influx。","x-is-registered":"Y","x-request-examples-1":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra-01","password":"******","region":"cn-xianhz-1","security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-2":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"charge_info":{"charge_mode":"prePaid","is_auto_pay":true,"is_auto_renew":true,"period_num":3,"period_type":"year"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra-01","password":"******","region":"cn-xianhz-1","security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-3":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra-01","password":"******","region":"cn-xianhz-1","restoration_info":{"backup_id":"2f4ddb93b9014b0893d81d2e472f30fe"},"security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-4":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"charge_info":{"charge_mode":"prePaid","is_auto_pay":true,"is_auto_renew":true,"period_num":3,"period_type":"year"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra-01","password":"******","region":"cn-xianhz-1","restoration_info":{"restore_time":1607731200000,"source_instance_id":"054e292c9880d4992f02c0196d3ein12"},"security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-5":{"availability_zone":"cn-southwest-244c","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"datastore":{"storage_engine":"rocksDB","type":"dynamodb","version":""},"disk_encryption_id":"bc2039e1-1b93-47cc-9db0-3571a9866a98","flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.large.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-dynamodb","password":"******","region":"cn-southwest-244","security_group_id":"17157fcb-8357-4ea5-9619-c07cb1610334","subnet_id":"c0650bbe-4c89-4f2a-8cd2-3e2171b96d99","vpc_id":"f457aa28-72de-42b8-8517-d9c6e14b9d09"},"x-request-examples-6":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"dr_info":{"source_instance_id":"3bd35299016749088d65f2c435190dbcin06"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra-01","password":"******","region":"cn-xianhz-1","security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-description-1":"请求体样例\n\n创建按需实例请求样例:\n> 请求体样例中参数“region”和“availability_zone”的值为示例值,具体取值请以实际环境为准。","x-request-examples-description-2":"请求体样例\n\n创建包周期实例请求样例:\n> 请求体样例中参数“region”和“availability_zone”的值为示例值,具体取值请以实际环境为准。","x-request-examples-description-3":"请求体样例\n\n创建根据指定备份恢复数据到一个新创建的按需实例请求样例:\n\n> 请求体样例中参数“region”和“availability_zone”的值为示例值,具体取值请以实际环境为准。","x-request-examples-description-4":"请求体样例\n\n创建恢复指定实例的指定时间点的数据到一个新创建的包周期实例请求样例:\n\n> 请求体样例中参数“region”和“availability_zone”的值为示例值,具体取值请以实际环境为准。","x-request-examples-description-5":"请求体样例\n\n创建磁盘加密的经典Dynamodb实例:\n> 请求体样例中参数“region”和“availability_zone”的值为示例值,具体取值请以实际环境为准。","x-request-examples-description-6":"请求体样例\n\n创建容灾实例请求样例:\n> 请求体样例中参数“region”和“availability_zone”的值为示例值,具体取值请以实际环境为准。","x-request-examples-text-1":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra-01","password":"******","region":"cn-xianhz-1","security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-text-2":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"charge_info":{"charge_mode":"prePaid","is_auto_pay":true,"is_auto_renew":true,"period_num":3,"period_type":"year"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra-01","password":"******","region":"cn-xianhz-1","security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-text-3":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra-01","password":"******","region":"cn-xianhz-1","restoration_info":{"backup_id":"2f4ddb93b9014b0893d81d2e472f30fe"},"security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-text-4":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"charge_info":{"charge_mode":"prePaid","is_auto_pay":true,"is_auto_renew":true,"period_num":3,"period_type":"year"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra-01","password":"******","region":"cn-xianhz-1","restoration_info":{"restore_time":1607731200000,"source_instance_id":"054e292c9880d4992f02c0196d3ein12"},"security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-text-5":{"availability_zone":"cn-southwest-244c","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"datastore":{"storage_engine":"rocksDB","type":"dynamodb","version":""},"disk_encryption_id":"bc2039e1-1b93-47cc-9db0-3571a9866a98","flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.large.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-dynamodb","password":"******","region":"cn-southwest-244","security_group_id":"17157fcb-8357-4ea5-9619-c07cb1610334","subnet_id":"c0650bbe-4c89-4f2a-8cd2-3e2171b96d99","vpc_id":"f457aa28-72de-42b8-8517-d9c6e14b9d09"},"x-request-examples-text-6":{"availability_zone":"az1xahz","backup_strategy":{"keep_days":8,"start_time":"08:15-09:15"},"datastore":{"storage_engine":"rocksDB","type":"cassandra","version":"3.11"},"dr_info":{"source_instance_id":"3bd35299016749088d65f2c435190dbcin06"},"flavor":[{"num":3,"size":500,"spec_code":"geminidb.cassandra.4xlarge.4","storage":"ULTRAHIGH"}],"mode":"Cluster","name":"test-cassandra","password":"******","region":"cn-xianhz-1","security_group_id":"7aa51dbf-5b63-40db-9724-dad3c4828b58","ssl_option":"1","subnet_id":"f1df08c5-71d1-406a-aff0-de435a51007","vpc_id":"674e9b42-cd8d-4d25-a2e6-5abcc565b961"},"x-request-examples-url-1":"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances","x-request-examples-url-3":"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建实例","tags":"实例管理","uri":null,"version":"2.0"}