响应消息 参数说明 表2 响应Body参数 名称 参数类型 是否必选 描述 instances Array of objects 是 实例信息。详情请参见表3。 total_count Integer 是 总记录数。 表3 instances字段数据结构说明 名称 参数类型 是否必选 描述 id String 是 实例ID。 name String 是 实例名称。 remark String 是 实例备注。 status String 是 实例状态。 取值： normal，表示实例正常。 abnormal，表示实例异常。 creating，表示实例创建中。 frozen，表示实例被冻结。 data_disk_full，表示存储空间满。 createfail，表示实例创建失败。 enlargefail，表示实例扩容节点个数失败。 说明： 实例正在执行的动作（actions），例如“rebooting，重启中”与实例状态（status）有本质的区别。详情请参见该表中的actions字段。 port String 是 数据库端口号。文档数据库实例支持的端口号范围为2100～9500。 mode String 是 实例类型。与请求参数相同。 region String 是 实例所在区域。 datastore Object 是 数据库信息。 详情请参见表4。 engine String 是 存储引擎。支持WiredTiger/RocksDB存储引擎。 数据库版本为4.2及以上时，存储引擎为RocksDB，取值为“rocksDB”。 数据库版本为4.0和3.4时，存储引擎为WiredTiger，取值为“wiredTiger”。 created String 是 实例创建时间。 updated String 是 实例操作最新变更的时间。 db_user_name String 是 默认用户名。取值为“rwuser”。 ssl Integer 是 是否开启SSL安全连接。 取值为“1”，表示开启。 取值为“0”，表示不开启。 vpc_id String 是 虚拟私有云ID。 subnet_id String 是 子网的网络ID。 security_group_id String 是 安全组ID列表。当实例存在多安全组时，多个安全组ID采用英文逗号分隔。 backup_strategy Object 是 备份策略。 详情请参见表5。 pay_mode String 否 计费方式。 取值为“0”，表示按需计费。 取值为“1”，表示包年/包月计费。 maintenance_window String 是 系统可维护时间窗。 groups Array of objects 是 组信息。 详情请参见表6。 disk_encryption_id String 是 磁盘加密的密钥ID。该参数仅在实例磁盘被加密时返回。 enterprise_project_id String 是 企业项目ID。 取值为“0”，表示为default企业项目。 time_zone String 是 时区。 dss_pool_id String 否 Dec用户专属存储ID。 actions Array of strings 是 实例正在执行的动作。 取值： RESTARTING，重启中。 RESTORE，恢复中。 RESIZE_FLAVOR，规格变更中。 RESTORE_TO_NEW_INSTANCE，恢复中。 MODIFY_VPC_PEER，跨子网访问设置中。 CREATE，创建中。 FROZEN，冻结。 RESIZE_VOLUME，存储扩容中。 RESTORE_CHECK，恢复检查中。 RESTORE_FAILED_HANGUP，恢复失败。 CLOSE_AUDIT_ LOG ，关闭审计策略中。 OPEN_AUDIT_LOG，打开审计策略中。 PERIOD_RESOURCE_SPEC_CHG，包周期资源变更检查中。 CREATE_IP_SHARD，shard IP显示开启中。 CREATE_IP_CONFIG，config IP显示开启中。 GROWING，节点扩容中。 SET_CONFIGURATION，修改参数中。 RESTORE_TABLE，恢复中。 MODIFY_SECURITYGROUP，修改安全组中。 BIND_EIP，修改公网EIP中。 UNBIND_EIP，解绑EIP中。 SWITCH_SSL，切换SSL中。 SWITCH_PRIMARY，主备切换中。 CHANGE_DBUSER_PASSWORD，修改密码中。 MODIFY_PORT，修改端口号中。 MODIFY_IP，修改内网IP中。 DELETE_INSTANCE，实例删除中。 REBOOT，重启中。 BACKUP，备份中。 MIGRATE_AZ，可用区迁移中。 PWD_RESETING，重置密码中。 UPGRADE_DATABASE，补丁升级中。 DATA_MIGRATION，数据迁移中。 SHARD_GROWING，分片扩容中。 APPLY_CONFIGURATION，变更参数组中。 RESET_PASSWORD，重置密码中。 GROWING_REVERT，删除节点中。 SHARD_GROWING_REVERT，分片删除中。 ONDEMAND_TO_PERIOD，转包周期中。 LOG_PLAINTEXT_SWITCH，慢日志配置修改中。 CREATE_DATABASE_USER，创建数据库用户中。 CREATE_DATABASE_ROLE，创建数据库角色中。 MODIFY_NAME，修改名称中。 MODIFY_PRIVATE_DNS，修改内网 域名 中。 MODIFY_OP_LOG_SIZE，oplog大小修改中。 ADD_READONLY_NODES，只读节点扩容中。 order_id String 否 订单ID，仅包周期场景返回。 tags Array of objects 是 标签列表。 详情请参见表9。 表4 datastore字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 数据库引擎。 version String 是 数据库版本。支持5.0、4.4、4.2、4.0、3.4版本，取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。 patch_available Boolean 是 当前实例是否有可升级的补丁，返回true时可以通过“数据库补丁升级”进行升级。 表5 backup_strategy字段数据结构说明 名称 参数类型 是否必选 描述 start_time String 是 备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。 keep_days Integer 是 已生成备份文件可以保存的天数。取值范围：0~732。 表6 groups字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 节点类型。 取值： shard config mongos replica single readonly id String 是 组ID。节点类型为shard、config和readonly时，该参数有效。 name String 是 组名称。节点类型为shard、config和readonly时，该参数有效。 status String 是 组状态。节点类型为shard、config和readonly时，该参数有效。 volume Object 是 volume信息。详情请参见表7。节点类型为shard、config、replica、single、readonly时，该参数有效。 nodes Array of objects 是 节点信息。详情请参见表8。 表7 volume字段数据结构说明 名称 参数类型 是否必选 描述 size String 是 磁盘大小。单位：GB。 used String 是 磁盘使用量。单位：GB。 表8 nodes字段数据结构说明 名称 参数类型 是否必选 描述 id String 是 节点ID。 name String 是 节点名称。 status String 是 节点状态。 role String 是 节点角色。 取值： master，mongos节点返回该值。 Primary，shard组主节点、config组主节点、副本集主节点、单节点返回该值。 Secondary，shard组备节点、config组备节点、副本集备节点返回该值。 Hidden，shard组隐藏节点、config组隐藏节点、副本集隐藏节点返回该值。 unknown，节点异常时返回该值。 Readonly, 只读节点返回改值。 private_ip String 是 节点内网IP。该参数默认仅针对集群实例的mongos节点、副本集实例、以及单节点实例有效，且在弹性云服务器创建成功后参数值存在，否则，值为""。 注意： 打开shard或者config IP 之后，集群实例的shard节点或者config节点的Primary、Secondary节点也会有该值。 public_ip String 是 绑定的外网IP。该参数仅针对集群实例的mongos节点、副本集实例的主节点和备节点、以及单节点实例有效。 spec_code String 是 资源规格编码。关于实例的规格信息，请参见查询数据库规格中响应参数“flavors.spec_code”的值。 availability_zone String 是 可用区。 表9 tag字段说明 名称 参数类型 是否必选 描述 key String 是 标签键。 value String 是 标签值。 响应示例中参数“region”和“availability_zone”的值为示例值。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}&tags={key}={value},{key}={value} URI样例 查询所有实例列表和详情 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances 根据指定条件查询实例列表和详情 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in02&name=hy&mode=ReplicaSet&datastore_type=DDS-Community&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&tags=key1=value1,key2=value2

请求示例 更新租户指定ID批量异步任务详情，任务模式为全量+增量，公网网络类型。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/batch-async-jobs/bd4193aa-072d-4ce6-beec-adffc7252341 { "jobs" : [ { "type" : "all", "params" : { "job_id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "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" } } } }, { "type" : "endpoint", "params" : { "job_id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "source_endpoint" : [ { "db_type" : "oracle", "endpoint_type" : "offline", "endpoint_role" : "so", "endpoint" : { "endpoint_name" : "oracle", "ip" : "10.154.227.134", "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" : { "id" : "f59e6118-da89-4fdb-9b98-65f56709928a", "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" }, "ssl" : { "ssl_link" : false } } ] } } ] }

响应示例 状态码： 202 Accepted { "jobs" : [ { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name" : "DRS-1234", "status" : "Success" }, { "id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "name" : "DRS-2345", "status" : "Failed", "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID" } ] } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

响应参数 状态码： 202 表35 响应Body参数 参数 参数类型 描述 jobs Array of objects 批量更新指定ID异步任务响应体。 详情请参见表36。 表36 jobs字段数据结构说明 参数 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 操作结果。 error_code String 错误码。 error_msg String 错误描述。 状态码： 400 表37 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

响应示例 状态码： 200 OK { "jobs" : [ { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name" : "DRS-1234", "status" : "Success" }, { "id" : "dc6016cf-f3b6-4c2d-b4d7-5084b0fjb20r", "name" : "DRS-2345", "status" : "Failed", "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID" } ] } 状态码： 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of objects 批量删除任务响应体。 详情请参见表5。 表5 jobs字段数据结构说明 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512 id String 任务ID。 name String 任务名称。 status String 删除结果。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：12 最大长度：12 error_msg String 错误描述。 最小长度：1 最大长度：512

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值：en-us 枚举值： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of strings 批量删除任务请求体。

响应参数 状态码： 401 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 401 Unauthorized { "error_code" : "APIC.7102", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 Forbidden { "error_code" : "APIC.7106", "error_msg" : "No permissions to request for the method"} 状态码： 404 Not Found { "error_code" : "APIC.7302", "error_msg" : "Instance not found"} 状态码： 500 Internal Server Error { "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service"}

约束与限制 CPH服务对批量控制风险与安全进行如下约束： 目前支持的控制命令： shell：在云手机设备中启动远程交互式shell。 install：将软件包安装到云手机系统。 uninstall：从云手机系统中移除软件包。 push：将文件或者文件夹从本地设备复制到云手机设备上。 控制命令数据和指令不当，会造成云手机故障并无法恢复。 如果需要执行install、push命令，则需要严格按照操作步骤进行设置，并独立构建批量控制APK数据桶与其他数据隔离。 如果需要执行install、push命令，文件必须为tar格式，压缩的文件路径按照AOSP（Android Open Source Project）的目录结构放置。 同一台云手机服务器，文件推送任务耗时与文件推送任务个数成正比。

响应示例 状态码： 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, "type" : 0, "availability_zone" : "xxxxxx", "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" : " CS 1710111105S8IPB", "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码。 type Integer 云手机类型。 0：普通云手机 traffic_type String 手机路由类型。 direct：默认路由 routing：路由到编码容器 volume_mode Integer 手机物理磁盘是否独立。 0：不独立 1：独立 availability_zone String 云手机服务器所在的可用区。如上海一可用区1为cn-east-3a。 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 云手机数据盘大小。

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 408 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 solution_msg String 解决方案描述

URI GET https://localhost.com/v1/workspaces/{workspace_id}/services/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 workspace_id 是 String 参数解释：Workspace的ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 instance_id 是 String 实例的Id。获取方法，请参见获取推理实例ID。