响应参数 状态码： 202 表36 响应Body参数 参数 参数类型 描述 job Object 批量创建异步任务响应体。 详情请参见表37。 表37 job字段数据结构说明 参数 参数类型 描述 async_job_id String 批量异步创建的任务ID。 状态码： 400 表38 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

请求示例 批量异步创建Oracle到 GaussDB 分布式版按需实时同步任务，任务模式为全量+增量，公网网络类型。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-async-create { "jobs" : [ { "base_info" : { "name" : "DRS-1234", "job_type" : "sync", "engine_type" : "oracle-to-gaussdbv5", "job_direction" : "up", "task_type" : "FULL_INCR_TRANS", "net_type" : "eip", "charging_mode" : "on_demand", "enterprise_project_id" : "0", "description" : "", "expired_days" : "14", "tags" : [ { "key" : "test", "value" : "test" } ] }, "source_endpoint" : [ { "db_type" : "oracle", "endpoint_type" : "offline", "endpoint_role" : "so", "endpoint" : { "endpoint_name" : "oracle", "ip" : "10.154.217.239", "db_port" : "1521", "db_user" : "ORACLE_USER", "db_name" : "serviceName.orcl", "db_password" : "******" }, "ssl" : { "ssl_link" : false } } ], "target_endpoint" : [ { "db_type" : "gaussdbv5", "endpoint_type" : "cloud", "endpoint_role" : "ta", "endpoint" : { "endpoint_name" : "cloud_gaussdbv5", "instance_id" : "c2c7579bc09c490b9d8009db715aeb0ain14", "db_user" : "root", "db_password" : "******" }, "cloud" : { "region" : "cn-north-4", "project_id" : "9dc8c0f3f74c4dbb23c29cf0318ee561", "az_code" : "cn-north-4a,cn-north-4g,cn-north-4c" }, "vpc" : { "vpc_id" : "2cb5d364-ae63-4fbb-85b7-7d59f4a88f8f", "subnet_id" : "2cb54324-ae63-4fbb-85b7-7d59f4a88f8f", "security_group_id" : "039a3s89-665a-43e2-9b4f-bda7d9ee148d" } } ], "alarm_notify" : { "alarm_to_user" : true, "topic_urn" : "urn:smn:cn-north-4:f2c2468c3ee7410c862a461ca073d2f2:test", "delay_time" : 60 }, "speed_limit" : [ { "begin" : "16:00", "end" : "15:59", "speed" : "10" } ], "policy_config" : { "ddl_trans" : false }, "db_object" : { "object_scope" : "table", "target_root_db" : { "db_name" : "target_db_name", "db_encoding" : "utf8" }, "object_info" : { "source_db1" : { "name" : "source_db1", "all" : false, "tables" : { "source_tb1" : { "type" : "table", "name" : "source_tb1", "all" : true }, "source_tb2" : { "type" : "table", "name" : "source_tb2", "all" : true } } } } }, "node_info" : { "spec" : { "node_type" : "medium" } } } ] }

请求示例 创建Oracle到GaussDB分布式版按需实时同步任务，任务模式为全量+增量，公网网络类型。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs { "job" : { "base_info" : { "name" : "DRS-1234", "job_type" : "sync", "engine_type" : "oracle-to-gaussdbv5", "job_direction" : "up", "task_type" : "FULL_INCR_TRANS", "net_type" : "eip", "charging_mode" : "on_demand", "enterprise_project_id" : "0", "description" : "", "expired_days" : "14", "tags" : [ { "key" : "test", "value" : "test" } ] }, "source_endpoint" : [ { "db_type" : "oracle", "endpoint_type" : "offline", "endpoint_role" : "so", "endpoint" : { "endpoint_name" : "oracle", "ip" : "10.154.217.239", "db_port" : "1521", "db_user" : "ORACLE_USER", "db_name" : "serviceName.orcl", "db_password" : "******" }, "ssl" : { "ssl_link" : false } } ], "target_endpoint" : [ { "db_type" : "gaussdbv5", "endpoint_type" : "cloud", "endpoint_role" : "ta", "endpoint" : { "endpoint_name" : "cloud_gaussdbv5", "instance_id" : "c2c7579bc09c490b9d8009db715aeb0ain14", "db_user" : "root", "db_password" : "******" }, "cloud" : { "region" : "cn-north-4", "project_id" : "9dc8c0f3f74c4dbb23c29cf0318ee561", "az_code" : "cn-north-4a,cn-north-4c,cn-north-4g" }, "vpc" : { "vpc_id" : "2cb5d364-ae63-4fbb-85b7-7d59f4a88f8f", "subnet_id" : "2cb54324-ae63-4fbb-85b7-7d59f4a88f8f", "security_group_id" : "039a3s89-665a-43e2-9b4f-bda7d9ee148d" } } ], "node_info" : { "spec" : { "node_type" : "medium" }, "vpc" : { "vpc_id" : "2cb5d364-ae63-4fbb-85b7-7d59f4a88f8f", "subnet_id" : "2cb54324-ae63-4fbb-85b7-7d59f4a88f8f" } } } }

响应示例 状态码： 200 OK { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name" : "DRS-1234", "status" : "CREATING", "create_time" : "2022-11-07T16:15:18Z", "is_clone_job": "false" } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

响应参数 状态码： 200 表20 响应Body参数 参数 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 任务状态。 create_time String 任务创建时间。 is_clone_job String 是否为克隆任务。 状态码： 400 表21 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

实例计费方式更改 支持实例包周期和按需计费方式互换。注意包周期转按需计费生效的前提是包周期已到期。 在左侧导航栏单击“实例管理”。 在需要更改计费方式的实例上，单击“更多”，选择“转包周期”或“转按需”。 按需转包周期：选择续费时长，单击“去支付”，完成付款即可。 包周期转按需：包周期转按需生效的前提是包周期已到期，包周期转按需操作可在包周期到期前或包周期到期后的冻结期内执行。单击“转按需”即可。

操作步骤 进入购买实例页面。 除墨西哥城一、北京一区域外，在其他区域购买实例后默认开启ELB负载。开启ELB负载的实例的安全组不生效，如需禁用部分IP请使用访问控制策略。 开启ELB负载：ELB作为网关入口的负载均衡器，入口支持跨VPC访问。但在开启公网入口时，弹性IP地址由网关随机分配，不支持选择已有弹性IP地址。 根据下表参数说明，配置实例参数。 表1 API网关实例参数说明 参数 说明 计费模式 实例收费方式，当前支持“按需计费”和“包周期”两种方式。 目前仅北京一、北京四、乌兰察布一、上海一、上海二、广州、广州-友好用户环境和贵阳一支持包周期收费方式。 区域 指APIG实例部署的区域，建议和您其他的业务部署在相同区域，这样不同的业务可以在负载内以子网方式通信，节省公网带宽成本，降低网络延时。 可用区 指同一区域内电力、网络等资源物理隔离的地理区域，一般为互相独立的机房。 APIG实例支持同时选择多个可用区，进行跨可用区部署，提升实例高可用性。 APIG不支持跨可用区迁移实例。 实例名称 实例的名称，根据规划自定义。 实例规格 当前开放基础版、专业版、企业版、铂金版实例。不同实例规格，对API请求的并发支持能力不同，具体请参考《API网关产品介绍》的规格说明章节。 说明： 目前仅上海一和北京四区域支持选择更多铂金版规格。 可维护时间窗 指允许云服务技术支持对实例进行维护的时间段。如果有维护需要，技术支持会提前与您沟通确认。 建议选择业务量较少的时间段。 企业项目 使用企业用户登录时，可选择实例所属企业项目。 有关企业项目的资源使用、迁移以及用户权限等，请参考《企业管理用户指南》。 公网入口 指允许外部服务通过弹性IP地址，调用实例创建的API。开启“公网入口”，需要绑定一个“弹性IP地址”，弹性IP地址另行收费。 说明： 在北京四、上海一、广州、贵阳一区域开启公网入口后，弹性IP地址由网关随机分配，不支持选择已有弹性IP地址。您可以根据业务预估设置合适的“入公网带宽”，入公网带宽费用按小时计算，以弹性IP服务的价格为准。 您需要使用独立 域名 /调试域名访问，使用调试域名访问时存在单日访问次数限制。可在创建API分组后，为分组绑定独立域名，独立域名需要解析到实例的弹性IP地址。 例如您有一个API，请求协议为HTTPS，Path为/apidemo，开启了公网访问，并为分组绑定了独立域名后，可使用https://{domain}/apidemo这个URL访问您的API。其中，{domain}表示已绑定到分组的独立域名，目标端口443可默认缺省。 公网出口 指允许API的后端服务部署在外部网络，APIG为实例开启公网出口。您可以根据业务预估设置合适的“出公网带宽”，出公网带宽费用按小时计算，以弹性IP服务的价格为准。 IPv6 仅在计费模式为“按需计费”时，需要配置。 如果后端服务部署在外部网络，且需要使用IPv6地址访问，则需要勾选“支持IPv6”。 说明： 目前仅北京四支持。 网络 指为实例绑定到一个VPC，并为其分配子网。 使用已创建的VPC和子网，请在下拉列表选择当前账号下创建的VPC和子网。 使用共享VPC和子网，请在下拉列表选择其他账号共享给当前账号的VPC和子网。 共享VPC基于 资源访问管理 （Resource Access Manager，简称 RAM ）服务的机制，VPC的所有者可以将VPC内的子网共享给一个或者多个账号使用。通过共享VPC功能，可以简化网络配置，帮助您统一配置和运维多个账号下的资源，有助于提升资源的管控效率，降低运维成本。有关VPC子网共享的更多信息，请参见共享VPC。 使用新的VPC和子网，请单击“控制台”，参考创建虚拟私有云创建待使用的新VPC和子网。 安全组 安全组用于设置端口访问规则，定义哪些端口允许被外部访问，以及允许访问外部哪些地址与端口。 例如，后端服务部署在外部网络，则需要设置相应的安全组规则，允许访问后端服务地址与API调用端口。 说明： 如果开启公网入口，安全组入方向需要放开80（HTTP）和443（HTTPS）端口的访问权限。 终端节点服务名称 填写终端节点服务名称。购买实例后，同步创建 VPC终端节点 服务，可以被终端节点连接和访问。 如果填写了终端节点服务名称，购买实例后，在实例详情中的“终端节点管理”页签下展示名称为{region}.{终端节点服务名称}.{终端节点服务ID}；如果终端节点服务名称为空，购买实例后，在实例详情中的“终端节点管理”页签下展示名称为{region}.{apig}.{终端节点服务ID}。 标签 通过标签对实例资源进行标记，批量分类实例资源，实现对实例资源进行分组查询、分析及管理。如果没有标签选择可单击“查看预定义标签”创建，也可以直接输入标签键值创建。 实例创建完成后，也可以在管理标签中设置。 说明： 如您的组织已经设定API网关服务的相关标签策略，则需按照标签策略规则为实例添加标签。标签如果不符合标签策略的规则，则可能会导致创建实例失败，请联系组织管理员了解标签策略详情。 购买时长 计费模式为“包年/包月”时配置。实例的购买时长，最短1个月。 描述 实例的描述信息。 单击“立即购买”，进入实例规格确认页面。 规格确认无误后，勾选服务协议，支付费用后，开始创建实例，界面显示创建进度。

网络环境准备 负载 虚拟私有云（Virtual Private Cloud，简称VPC）。实例需要配置虚拟私有云（负载），在同一负载中的资源（如E CS ），可以使用实例的私有地址调用API。 在创建实例时，建议配置和您其他关联业务相同负载，确保网络安全的同时，方便网络配置。 创建实例后，不支持修改虚拟私有云（负载）。 弹性公网IP 实例的API如果要允许外部调用，则需要创建一个弹性公网IP，并与实例绑定，作为实例的公网入口。 如果API的后端服务部署在公网，还需要有公网出口访问权限，这由API网关统一规划，不需要单独创建弹性公网IP。 安全组 安全组类似防火墙，控制谁能访问实例的指定端口，以及控制实例的通信数据流向指定的目的地址。安全组入方向规则建议按需开放地址与端口，这样可以保护实例的网络安全。 实例绑定的安全组有如下要求： 入方向：如果需要从公网调用API，或从其他安全组内资源调用API，则需要为实例绑定的安全组的入方向放开80（HTTP）、443（HTTPS）两个端口。 出方向：如果后端服务部署在公网，或者其他安全组内，则需要为实例绑定的安全组的出方向放开后端服务地址与API调用端口。 如果API的前后端服务与实例绑定了相同的安全组、相同的虚拟私有云，则无需专门为实例开放上述端口。

购买的约束说明 创建实例存在一些约束，当您登录后无法创建实例，或者创建失败，请参考以下约束说明进行检查，并解除限制。 实例配额 同一项目ID下，一个主账号默认只能创建5个实例。如果您需要创建更多实例，可提交工单，申请修改配额。 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略，则拥有“APIG FullAccess”即可。 如果使用自定义策略，请参考对用户组授权。 子网中可用私有地址数量 API网关专享实例的基础版、专业版、企业版，以及铂金版分别需要3、5、6、7个私有地址。在铂金版的基础上，铂金版X依次增加4个私有地址。请确保您选择的子网段有足够多的私有地址可用，私有地址可在虚拟私有云服务的控制台查询。

约束限制 转为高可用只读实例时，原只读规格支持SSD云盘、本地盘： SSD云盘：支持通用型、独享型和鲲鹏通用增强型。 本地盘：支持x86通用型和x86独享型。本地盘单机版只读实例如果需要转为高可用只读，请联系客服申请。 DEC用户支持创建高可用只读实例以及只读转高可用，资源类型选择“专属存储”时，默认只显示购买专属分布式存储服务时选择的存储类型。 证书、磁盘加密、端口、子网信息跟已有高可用只读一致（若没有高可用只读，则跟主实例一致）时，非高可用只读才可变更到高可用只读。 创建高可用只读或是变更到高可用只读时，需要保证实例所在子网的可用私有IP数量≥ 3。 不建议修改高可用只读实例的参数，否则会影响到高可用只读的可靠性。 高可用只读不允许进行如下操作：修改端口、转换到非高可用只读实例。

约束限制 创建高可用只读实例时，高可用只读规格支持SSD云盘、本地盘： SSD云盘：支持通用型、独享型、惠选型和鲲鹏通用增强型。 本地盘：支持x86通用型和x86独享型。 转为高可用只读实例时，原只读规格支持SSD云盘、本地盘： SSD云盘：支持通用型、独享型、惠选型和鲲鹏通用增强型。 本地盘：支持x86通用型和x86独享型。本地盘单机版只读实例如果需要转为高可用只读，请联系客服申请。 DEC用户支持创建高可用只读实例以及只读转高可用，资源类型选择“专属存储”时，默认只显示购买专属分布式存储服务时选择的存储类型。 创建时不支持设置证书、磁盘加密、端口、子网信息，上述信息均与已有高可用只读一致，如果没有创建过高可用只读实例，则与主实例保持一致。 证书、磁盘加密、端口、子网信息跟已有高可用只读一致（若没有高可用只读，则跟主实例一致）时，非高可用只读才可变更到高可用只读。 创建高可用只读或是变更到高可用只读时，需要保证实例所在子网的可用私有IP数量≥ 3。 不建议修改高可用只读实例的参数，否则会影响到高可用只读的可靠性。 高可用只读不允许进行如下操作：修改端口、转换到非高可用只读实例。 建议创建只读实例时，设置实例规格不低于主实例，否则可能导致创建只读失败和复制延迟升高。 创建只读实例时不要有DDL操作，否则可能会导致创建只读失败。

响应示例 状态码： 200 OK { "request_id" : "70bb40bef50e4a14b116a5a527fd7432", "phone_name" : "mobile-0049", "server_id" : "88b8449b896f3a4f0ad57222dd91909", "phone_id" : "1564567b8bab40f34711234cb80d8574", "image_id" : "88b8449b896f3a4f0ad57222dd91909", "phone_model_name" : "aphs1.large.2.aosp", "image_version" : "AOSP 7.0", "status" : 2, "imei" : 869287243397729, "availability_zone" : "cn-southwest-242b", "traffic_type" : "direct", "volume_mode" : 0, "phone_data_volume" : { "volume_type" : "GPSSD", "volume_size" : 10 }, "access_infos" : [ { "type" : "server1", "device_ip" : "10.237.0.61", "phone_ip" : "10.237.0.61", "listen_port" : 38080, "access_ip" : "213.32.43.210", "public_ip" : "213.32.43.210", "intranet_ip" : "172.31.0.123", "server_ip" : "172.31.0.123", "access_port" : 14308, "phone_ipv6" : "fd00::aed:3d", "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d" }, { "type" : "server2", "device_ip" : "10.237.0.61", "phone_ip" : "10.237.0.61", "listen_port" : 38081, "access_ip" : "213.32.43.210", "public_ip" : "213.32.43.210", "intranet_ip" : "172.31.0.123", "server_ip" : "172.31.0.123", "access_port" : 14328, "phone_ipv6" : "fd00::aed:3d", "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d" } ], "property" : "{\"sys.prop.writephonenum\":\"13666666666\",\"sys.prop.writeimsi\":\"460021624617113\",\"sys.prop.writewifissid\":\"test_wifi\"}", "metadata" : { "order_id" : "CS1710111105S8IPB", "product_id" : "00301-25217-0--0" }, "create_time" : "2017-10-10T00:00:00Z", "update_time" : "2018-11-12T00:00:00Z" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求的唯一标识ID，不超过32个字节。 phone_name String 云手机名称，不超过65个字符。 server_id String 云手机服务器ID，不超过32个字节。 phone_id String 云手机的唯一标识，不超过32个字节。 image_id String 云手机镜像ID，不超过32个字节。 image_version String 镜像版本。 vnc_enable String 云手机是否开启VNC服务（过期） true：开启 false：关闭 phone_model_name String 云手机规格名称，不超过64个字节。 status Integer 云手机状态。 1：创建中 2：运行中 3：重置中 4：重启中 6：冻结 7：正在关机 8：已关机 -5：重置失败 -6：重启失败 -7：手机异常 -8：创建失败 -9：关机失败 access_infos Array of PhoneAccessInfo objects 云手机访问信息。 property String 云手机属性字符串，不超过2048个字节。 metadata metadata object 订单以及产品相关信息。 phone_data_volume PhoneDataVolume object 云手机数据盘信息。 imei String imei码。 traffic_type String 手机路由类型。 direct：默认路由 routing：路由到编码容器 volume_mode Integer 手机物理磁盘是否独立。 0：不独立 1：独立 availability_zone String 云手机服务器所在的可用区。 has_encrypt Boolean 当前手机是否开启文件级加密。 create_time String 创建时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 update_time String 更新时间， 时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。 表4 PhoneAccessInfo 参数 参数类型 描述 type String 自定义端口类型，不超过16个字节。 device_ip String 云手机IP（过期）。 phone_ip String 云手机IP。 listen_port Integer 服务监听端口。 access_ip String 云手机服务器的访问IP（过期）。 public_ip String 云手机服务器的公网IP，如果端口设置了非公网访问，该字段返回空字符串。 intranet_ip String 云手机服务器的内网IP（过期）。 server_ip String 云手机服务器的内网IP。 access_port Integer 服务映射到公网的访问端口。 phone_ipv6 String 云手机IPv6 IP，新增字段。 server_ipv6 String 云手机服务器IPv6 IP，新增字段。 表5 metadata 参数 参数类型 描述 order_id String 订单ID，不超过64个字节。 product_id String 产品ID，不超过64个字节。 表6 PhoneDataVolume 参数 参数类型 描述 volume_type String 云手机数据盘类型。 volume_size Integer 云手机数据盘大小。

请求示例 创建一个GaussDB实例，实例部署形态为分布式独立部署，包周期付费（1年），引擎版本为2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-independent-02", "datastore": { "type": "GaussDB", "version": "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备），按需付费，引擎版本为2.7，同一可用区下，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-ha-01", "datastore": { "type": "GaussDB", "version": "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年），引擎版本为2.，三个不同可用区下，规格为8U64G。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances { "name": "user1-v3-ha-02", "datastore": { "type": "GaussDB", "version": "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(企业版) ，combined(基础版混合部署)，主备版取值: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，表示手动从账户中支付，默认为该支付方式。