注意事项 实例版本说明 部分版本的 堡垒机 升级至最新实例版本时，需要执行两次升级。因此升级实例版本前，请先确认 云堡垒机 当前设备系统的版本，并确认升级流程，如表1所示。 表1 升级云堡垒机实例版本至最新版本流程说明 升级前云堡垒机实例版本 升级至最新实例版本操作流程 3.3.37.0及以下版本 需进行两次升级。 第一次升级：从当前版本升级至3.3.37.6版本，升级期间不能回退。 第二次升级：从3.3.37.6版本升级至最新版本。 3.3.38.0~3.3.50.0版本（含3.3.38.0和3.3.50.0） 需进行两次升级。 第一次升级：从当前版本升级至3.3.50.4版本，升级期间不能回退。 第二次升级：从3.3.50.4版本升级至最新版本。 3.3.52.0及以上版本（最新版本除外） 直接从当前已安装版本升级至最新版本即可。 升级前 为防止因升级失败而影响使用，建议升级前备份数据，备份说明请参见备份CBH数据。 预约升级，升级时间需要比当前时间至少晚一天（24h），建议您在无业务使用时升级，预约升级任务后，不能关机，重启，变更，扩容操作，升级任务开始前可以取消，重新设置升级时间。 升级中 版本升级过程约需要30min，版本升级期间云堡垒机系统不可用，但不影响主机资源运行。但在升级期间，建议用户不要登录云堡垒机系统进行操作，以免重要数据丢失。 版本升级完成或者跨版本升级过程中，您可以在堡垒机实例详情页面选择“版本回退”，版本回退开始后堡垒机“运行状态”会变为“版本回滚中”。 升级后 版本升级完成后会自动“重启”云堡垒机，重启完成后，即可使用云堡垒机。 版本升级后用户可正常继续使用原有配置和存储数据，升级不影响系统原有配置和存储数据。 跨版本升级成功后有七天回退保留期（回退保留期间升级按钮置灰，不支持升级操作），超过七天不可回退，请升级完成后及时验证堡垒机内的数据。 升级后的扩容操作不可回退，在升级完成后，如您需要进行扩容操作请等待5分钟后再进行，且务必在验证数据无误后再进行扩容或变更操作。 跨版本升级成功后，实例ID、服务器ID、实例版本号和创建时间会发生变化。 堡垒机跨版本升级会自动开放80、8080、443、2222共四个端口，升级完成后若不需要使用请第一时间关闭。 主备实例跨版本升级会自动开放22、31036、31679、31873共四个端口，升级完成后保持31679开放即可，其余端口若不需要使用请第一时间关闭。 跨版本升级前请您注意是否有在该实例中导入过Web证书，若升级前已导入，请在升级完成后重新导入一次。 版本回退 版本回退后版本会变为升级前的版本状态，升级后修改或新增的数据会丢失，并且因为数据回滚会导致当前堡垒机业务中断，请您谨慎操作。

响应示例 状态码：200 Instance Informations { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version" : "v1.1.1" }, "dataclass" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "dataobject" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "status" : "TERMINATED", "trigger_type" : "string", "start_time" : "2021-01-30T23:00:00Z+0800", "end_time" : "2021-01-30T23:00:00Z+0800" }

响应参数 状态码：200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 id String 剧本实例ID name String 剧本实例名称 project_id String 项目ID playbook PlaybookInfoRef object 剧本信息 dataclass DataclassInfoRef object 数据类信息 dataobject DataobjectInfo object 数据对象详情 status String 剧本实例状态. (RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止) trigger_type String 触发类型. TIMER--定时触发, EVENT--事件触发 start_time String 创建时间 end_time String 更新时间 表5 PlaybookInfoRef 参数 参数类型 描述 id String 剧本ID version_id String 剧本版本ID name String 名称 version String 版本 表6 DataclassInfoRef 参数 参数类型 描述 id String 数据类ID name String 数据类名称 表7 DataobjectInfo 参数 参数类型 描述 id String ID值 create_time String 创建时间 update_time String 更新时间 project_id String 项目ID dataclass_id String 数据类ID name String 名称 content String 数据内容 状态码：400 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表9 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID instance_id 是 String instance _id

搜索知识仓实例 进入LMS控制台。 在知识仓实例列表上方的搜索框中单击左键，在一级下拉框中选择“名称”、“区域”、“状态”、“规格”、“创建时间”，然后在二级下拉框中选择您需要的选项，也可以输入关键字后再进行选择，搜索到的知识仓实例会展示在列表中。 或在知识仓实例列表上方的搜索框中直接输入关键字，按Enter键。搜索到的知识仓实例“名称”、“区域”、“状态”、“规格”、“创建时间”中包含关键字的所有知识仓实例会展示在列表中。

创建知识仓实例 单个账号支持创建的知识仓实例数量不超过16个。 进入LMS控制台，单击“创建知识仓实例”。 如图1所示，根据界面提示配置参数，参数说明如表1所示。 图1 创建知识仓实例界面 表1 参数说明 参数 是否必选 说明 示例 计费模式 是 当前只支持按需计费模式。 按需计费 区域 是 租户所在的区域，当前区域请在界面左上方选择。 选择和云服务器同一个区域。 华北-北京四 中国-香港 EU-Dublin 可用区 是 可用区指在同一区域下，电力、网络隔离的物理区域，可用区之间内网互通，不同可用区之间物理隔离。 建议您选择和云服务器相同的可用区。 可用区1 知识仓实例名称 是 知识仓实例名称，全域唯一。 知识仓的命名规范为：{用户自定义前缀}-{当前控制台所在区域的区 域名 }-{账号ID}。 需要满足如下规范： 输入长度不能小于3个字符。 输入长度不能超过63个字符。 支持小写字母、数字、中划线（-）。 中划线（-）不得出现在字符串的头部或者尾部。 只能以小写字母开头。 storeprefix-cn-north-4-domainid CU规格 是 CU即计算单元（Compute Unit），用于衡量知识仓实例计算能力的指标，在数据检索和分析时用于执行计算任务。 可选择的知识仓实例计算单元的规格。根据业务规模选择的对应的规格。 CU规格取值范围：xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge。 4xlarge CU数量 是 知识仓实例配置的CU数量，单位：个。 该数据会占用CU资源配额数量。 CU规格与CU配额的换算关系是：xlarge占1个CU配额，2xlarge占用2个CU配额，以此类推，16xlarge占用16个CU配额。当CU配额不够时，请提工单申请。 1 配置完成后，单击“下一步”。 核对知识仓实例信息，确认无误后单击“立即创建”。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Boolean 返回值 status String 状态 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "result" : true, "status" : "success" } 状态码： 403 Forbidden { "error_code" : "IDE.00010129", "error_msg" : "Instance does not belong to the user or tenant" } 状态码： 404 Not Found { "error_code" : "IDE.00010030", "error_msg" : "instance not exist" }

URI URI格式 PUT /v3/{project_id}/instances/{instance_id}/db-auto-upgrade 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 非空。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 非空。 取值范围： 不涉及。 默认取值： 不涉及。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。取值规则如下： RDS for MySQL支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线、点或者下划线，不能包含其他的特殊字符。 RDS for PostgreSQL和RDS for SQL Server支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线或者下划线，不能包含其他的特殊字符。

响应示例 创建一个 GaussDB 分布式独立部署，按需付费，引擎版本为V2.0-2.7，同一可用区下，3个协调节点，3个分片，3个副本，规格为8U64G的实例： { "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-independent-01", "status": "BUILD", "datastore": { "type": "GaussDB", "version": "V2.0-2.7" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", "consistency": "strong" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, "replica_num": 3, "region": "aaa", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "enterprise_project_id": "0", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "charge_info": { "charge_mode": "postPaid" } }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af" } GaussDB分布式部署形态，包周期付费（1年），引擎版本为V2.0-2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G的实例响应： { "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-independent-02", "datastore": { "type": "GaussDB", "version": "V2.0-2.7" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", "consistency": "strong" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, "replica_num": 3, "region": "aaa", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "enterprise_project_id": "0", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "charge_info": { "charge_mode": "prePaid", "period_type": "year", "period_num": 1, "is_auto_renew": false, "is_auto_pay": false } }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af" } GaussDB集中式版高可用（1主2备），按需付费，引擎版本为V2.0-2.7，同一可用区下，规格为8U64G的实例响应： { "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-ha-01", "status": "BUILD", "datastore": { "type": "GaussDB", "version": "V2.0-2.7" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", "consistency": "strong" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, "region": "aaa", "replica_num": 3, "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "enterprise_project_id": "0", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "charge_info": { "charge_mode": "postPaid" }, "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f" }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af" } GaussDB集中式版高可用（1主2备），包周期付费（1年），引擎版本为V2.0-2.7，三个不同可用区下，规格为8U64G的实例响应： { "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-ha-02", "datastore": { "type": "GaussDB", "version": "V2.0-2.7" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", "consistency": "strong" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, "replica_num": 3, "region": "aaa", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "enterprise_project_id": "0", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "charge_info": { "charge_mode": "prePaid", "period_type": "year", "period_num": 1, "is_auto_renew": false, "is_auto_pay": false } }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af" }

请求示例 创建一个GaussDB实例，实例部署形态为分布式独立部署，包周期付费（1年），引擎版本为V2.0-2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.2/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-independent-02", "datastore": { "type": "GaussDB", "version": "V2.0-2.7" }, "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "volume": { "type": "ULTRAHIGH", "size": 120 }, "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab", "region": "aaa", "availability_zone": "bbb,ccc,ddd", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "charge_info": { "charge_mode": "prePaid", "period_type": "year", "period_num": 1 }, "password": "xxxxxx", "configuration_id": "", "enterprise_project_id": "", "time_zone": "UTC+08:00", "ha":{ "mode":"enterprise", "consistency":"strong", "replication_mode":"sync" }, "sharding_num": 3, "coordinator_num": 3, "replica_num": 3, "port":8000, "enable_force_switch":true } 创建一个GaussDB实例，实例部署形态为集中式版高可用（1主2备），按需付费，引擎版本为V2.0-2.7，同一可用区下，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.2/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-ha-01", "datastore": { "type": "GaussDB", "version": "V2.0-2.7" }, "flavor_ref": "gaussdb.opengauss.ee.km1.2xlarge.arm8.ha", "volume": { "type": "ULTRAHIGH", "size": 120 }, "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab", "region": "aaa", "availability_zone": "bbb,bbb,bbb", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "charge_info": { "charge_mode": "postPaid" }, "password": "xxxxxx", "configuration_id": "", "enterprise_project_id": "", "time_zone": "UTC+08:00", "ha": { "mode": "centralization_standard", "consistency": "strong", "replication_mode": "sync" }, "replica_num": 3, "port": 8000, "enable_force_switch": true } 创建一个GaussDB实例，实例部署形态为集中式版高可用（1主2备），包周期付费（1年），引擎版本为V2.0-2.7，三个不同可用区下，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.2/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-ha-02", "datastore": { "type": "GaussDB", "version": "V2.0-2.7" }, "flavor_ref": "gaussdb.opengauss.ee.km1.2xlarge.arm8.ha", "volume": { "type": "ULTRAHIGH", "size": 120 }, "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab", "region": "aaa", "availability_zone": "bbb,ccc,ddd", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, "charge_info": { "charge_mode": "prePaid", "period_type": "year", "period_num": 1 }, "password": "xxxxxx", "configuration_id": "", "enterprise_project_id": "", "time_zone": "UTC+08:00", "ha": { "mode": "centralization_standard", "consistency": "strong", "replication_mode": "sync" }, "replica_num": 3, "port": 8000, "enable_force_switch": true }

响应参数 表8 响应参数 名称 参数类型 说明 instance Object 实例信息。 详情请参见表9。 job_id String 实例创建的任务ID。 仅创建按需实例时会返回该参数。 order_id String 订单号，创建包年包月时返回该参数。 表9 instance说明 名称 参数类型 说明 id String 实例ID。 name String 实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。 取值范围：4~64个字符之间，必须以字母开头，不区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 status String 实例状态。如BUILD，表示创建中。 仅创建按需实例时会返回该参数。 datastore Object 数据库信息。 详情请参见表10。 ha Object 数据库部署形态。 详情请参见表11。 replica_num Integer 实例副本集数。 port String 数据库端口信息，与请求参数相同。 backup_strategy Object 自动备份策略。 详情请参见表12。 enterprise_project_id String 项目标签。 flavor_ref String 规格码，取值范围：非空。 volume Object volume信息。 详情请参见表13。 region String 区域ID。 availability_zone String 可用区ID。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 实例所属的安全组。 charge_info Object 付费方式信息。 详情请参见表14。 表10 datastore字段数据结构说明 名称 参数类型 说明 type String 数据库引擎，返回值如下： GaussDB version String 数据库版本。 表11 ha字段数据结构说明 名称 参数类型 说明 mode String GaussDB分布式模式支持取值：enterprise(企业版) ，集中式版取值:centralization_standard，不区分大小写。 replication_mode String 备机同步模式。固定取值为sync，表示数据同步方式为“同步模式”。 consistency String GaussDB的预留参数：指定事务一致性类型，取值范围： strong：强一致性。 eventual：最终一致性。 consistency_protocol String 指定副本一致性协议类型，取值范围：quorum 、paxos。不填时，默认为quorum。 表12 backup_strategy字段数据结构说明 名称 参数类型 说明 start_time String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 取值示例： 08:00-09:00 23:00-00:00 如果请求体中不填写“backup_strategy”字段，则响应体中 “start_time”默认返回“02:00-03:00”。 keep_days Integer 指定已生成备份文件的可保存天数。 取值范围：1～732。如果请求体中不填写“backup_strategy”字段，则响应体中 “keep_days”默认填写为7天。 表13 volume字段数据结构说明 名称 参数类型 说明 type String 磁盘类型。 取值如下，区分大小写： ULTRAHIGH，表示SSD盘。 ESSD,表示极速云盘。 size Integer 磁盘大小。 表14 charge_Info字段数据结构说明 名称 参数类型 说明 charge_mode String 计费模式。 postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。 period_type String 订购周期类型。month：包月。year：包年。说明：“charge_mode”为“prePaid”时生效，且为必选值。 枚举值： month year period_num Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。当“period_type”为“year”时，取值为1~3。 is_auto_renew Boolean 创建包周期实例时可指定,表示是否自动续订,续订时会自动支付。 按月订购时续订周期默认为1个月,按年订购时续订周期默认为1年,续订周期可自定义修改。 true,表示自动续订。 false,表示不自动续订,默认为该方式。 is_auto_pay Boolean 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该支付方式。

请求参数 表2 请求参数 名称 是否必选 参数类型 说明 name 是 String 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。 取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 datastore 是 Object 数据库信息。 详情请参见表3。 ha 是 Object 实例部署形态。详情请参见表4。 configuration_id 否 String 参数模板ID。当不传该参数时，使用系统默认的参数模板，且响应体中不返回该参数。 port 否 String 数据库对外开放的端口，不填默认为8000，可选范围为：1024-39998。限制端口： 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。 password 是 String 数据库密码。 GaussDB密码取值范围: 非空; 至少包含大写字母(A-Z)，小写字母(a-z)，数字(0-9)，非字母数字字符(限定为~!@#%^*-_=+?,)四类字符中的三类字符;长度8~32个字符。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 backup_strategy 否 Object 备份策略。 详情请参见表5。 enterprise_project_id 否 String 企业项目ID。只有企业租户时该参数才生效。 使用请参考《企业管理 API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。 disk_encryption_id 否 String 用于磁盘加密的密钥ID，默认为空。 密钥授权请参考《 数据加密 服务 用户指南》的“创建授权”章节。 flavor_ref 是 String 规格码，取值范围：非空。参考查询数据库规格中“spec_code”字段获取。 volume 是 Object volume信息。 详情请参见表6。 region 是 String 区域ID。 取值范围：非空，请参见地区和终端节点。 availability_zone 是 String 可用区ID。 GaussDB取值范围：非空，可选部署在相同可用区或不同可用区，可用区之间用逗号隔开。 取值范围：非空，请参见地区和终端节点。 vpc_id 是 String 虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id 是 String 子网的网络ID信息，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 security_group_id 是 String 指定实例所属的安全组。如果不需要指定安全组，请联系客服申请白名单。 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。 charge_info 否 Object 计费类型信息，仅支持按需和包周期。 详情请参见表7。 time_zone 否 String UTC时区。 不选择时，GaussDB国内站默认为UTC时间。 选择填写时，取值范围为UTC-12:00~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。 sharding_num 否 Integer 仅分布式形态需要填写该参数。分片数量，取值范围1~9。 coordinator_num 否 Integer 仅分布式形态需要填写该参数。协调节点数量，取值范围1~9。CN数量必须小于或等于两倍的分片数。 replica_num 否 Integer 实例副本集数，支持取值3。不填默认为3。 enable_force_switch 否 Boolean enable_force_switch表示是否开启备机强升主功能，仅支持取值true，false。true表示开启备机强升主功能，false表示关闭，默认关闭。仅支持1.2.2及以上版本。 说明： 备机强升主功能适用场景：在主机发生故障后，为了保障集群的可用性，强制拉起备机作为新主机对外提供服务。本功能在集群故障状态下，以丢失部分数据为代价换取集群尽可能快的恢复服务，是集群状态为不可用时的一个逃生方法。 enable_single_float_ip 否 Boolean 单浮动IP策略，仅V2.0-3.207及以上版本的集中式版实例支持。默认值是false，表示不开启单浮动IP策略。 取值范围： true：开启单浮动IP策略，实例将只有一个浮动IP绑定主节点，如果发生主备倒换，浮动IP不会发生变化。 false：不开启单浮动IP策略，每个节点都会绑定一个浮动IP，如果发生主备倒换，浮动IP会发生变化。 表3 datastore字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 数据库引擎，取值如下： GaussDB。不区分大小写。 version 否 String 数据库版本。不填时，默认为当前最新版本。 GaussDB支持的版本参考查询数据库引擎的版本查询。 表4 ha字段数据结构说明 名称 是否必选 参数类型 说明 mode 是 String GaussDB为分布式模式取值：enterprise(企业版) ，集中式版取值:centralization_standard，不区分大小写。 consistency 是 String 指定事务一致性类型，取值如下，不区分大小写： strong：强一致性。 eventual：最终一致性。 replication_mode 是 String 备机同步模式。固定取值为sync，表示数据同步方式为“同步模式”。 instance_mode 否 String 指定创建实例的产品类型。不传该参数默认创建企业版实例，创建基础版和生态版需要指定参数值。 enterprise：创建企业版实例。 basic：创建基础版实例。 ecology：创建生态版实例。 表5 backup_strategy字段数据结构说明 名称 是否必选 参数类型 说明 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空且非负，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 取值示例： 08:00-09:00 23:00-00:00 keep_days 否 Integer 指定备份文件的可保存天数。 取值范围： 1~36500。该参数缺省时，默认填写为7天。 表6 volume字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 磁盘类型。 仅支持ULTRAHIGH和ESSD，区分大小写，分别表示SSD和极速云盘。 size 是 Integer 磁盘大小。例如：该参数填写为“40”，表示为创建的实例分配40GB的磁盘空间。 E CS 部署方案：取值范围：（分片数*40GB）~（分片数*24TB），且大小只能为分片数*4GB的整数倍。 表7 chargeInfo字段数据结构说明 名称 是否必选 参数类型 说明 charge_mode 是 String 计费模式。 postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。 period_type 否 String 订购周期类型。“charge_mode”为“prePaid”时生效，且为必选值。 取值范围： month：包月。 year：包年。 period_num 否 Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3。 当传入浮点型时，会自动截取为整型。 is_auto_renew 否 Boolean 创建包周期实例时可指定,表示是否自动续订,续订时会自动支付。 按月订购时续订周期默认为1个月,按年订购时续订周期默认为1年,续订周期可自定义修改。 true，为自动续订。 false，为不自动续订，默认该方式。 is_auto_pay 否 Boolean 创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true，为自动支付。 false，为手动支付，默认该方式。

响应消息 参数说明 状态码：202 表3 响应Body参数 参数 参数类型 说明 job_id String 参数解释： 任务ID，仅按需实例返回该参数。 取值范围： 不涉及。 order_id String 参数解释： 订单ID，仅包周期实例返回该参数。 取值范围： 不涉及。 状态码：default 表4 ErrorResponse 参数 参数类型 说明 error_code String 参数解释： 提交任务异常时返回的错误编码。 取值范围： 不涉及。 error_msg String 参数解释： 提交任务异常时返回的错误描述信息。 取值范围： 不涉及。 响应示例 状态码： 202 Accepted. { "job_id" : "6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc" }