服务器管理-华为云

云桌面 WORKSPACE-查询租户的所有HDA最新版本:响应参数

响应参数状态码：200 表3 响应Body参数参数参数类型描述 items Array of LatestVersionInfo objects 租户的HDP最新版本信息列表。表4 LatestVersionInfo 参数参数类型描述 latest_version String 租户的HDP最新版本。 hda_type String HDA类型： SBC - 非VDI下SBC类型 OA_APP - VDI下非GPU类型 PT_APP - VDI下GPU类型状态码：400 表5 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：401 表6 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：403 表7 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：404 表8 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：405 表9 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：409 表10 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：500 表11 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：503 表12 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

云桌面 WORKSPACE 服务器管理

云桌面 WORKSPACE-创建云服务器:请求示例

请求示例 { "availability_zone" : "cn-north-5a", "subnet_id" : "085ca7d8-4474-4c32-bff0-31254d98c4a9", "nics" : [ { "subnet_id" : "085ca7d8-4474-4c32-bff0-31254d98c4a9" } ], "product_id" : "workspace.appstream.general.xlarge.2", "flavor_id" : "c3.large.4", "os_type" : "Windows", "root_volume" : { "type" : "SAS", "size" : 80 }, "server_group_id" : "f309fa65-881a-4f49-8c06-31e20437ae20", "vpc_id" : "d987ecf7-c6a4-4753-8b66-135dcc3eed79", "ou_name" : "", "update_access_agent" : false, "type" : "createApps", "subscription_num" : 1, "create_server_extend_param" : { "charging_mode" : "prePaid", "period_type" : 3, "period_num" : 2, "is_auto_renew" : false, "is_auto_pay" : false } }

云桌面 WORKSPACE 服务器管理

云桌面 WORKSPACE-创建云服务器:响应参数

响应参数状态码：200 表8 响应Body参数参数参数类型描述 job_id String 对于创建云应用服务器命令下发后会返回job_id，通过job_id可以查询任务的执行状态,按需购买返回该参数。 order_id String 订单号，创建包年包月的弹性云服务器时返回该参数。状态码：400 表9 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：401 表10 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：403 表11 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：500 表12 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

云桌面 WORKSPACE 服务器管理

云桌面 WORKSPACE-创建云服务器:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 否 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求Body参数参数是否必选参数类型描述 type 是 String 创建云服务类型，当前仅支持创建云应用：createApps。 server_group_id 是 String 服务器组唯一标识。 availability_zone 否 String 可用分区。说明：将服务创建到指定的可用分区，如果不指定则使用系统随机的可用分区。获取方式详见可用区管理ListAvailabilityZone："GET /v1/{project_id}/availability-zone"。 subscription_num 是 Integer 订购数量。 nics 否 Array of Nic objects 服务对应的网卡信息，当前未使用该字段。 ou_name 否 String OU名称，在对接AD时使用，需提前在AD中创建OU。 product_id 是 String 产品ID。说明：获取方式详见产品套餐管理ListProduct："GET /v1/{project_id}/product"。 flavor_id 否 String 规格ID。 os_type 否 String 操作系统类型，当前仅支持Windows。 root_volume 是 Volume object 系统盘：磁盘容量，磁盘容量最大只支持1024G, 且为10的倍数。 scheduler_hints 否 WdhParam object 专属主机：专属主机只支持按需模式，包周期模式不支持专属主机。 subnet_id 是 String 网卡对应的子网ID。 vpc_id 是 String 虚拟私有云ID。 update_access_agent 否 Boolean 是否自动升级hda版本。 create_server_extend_param 否 CreateServerExtendParam object 创建云服务器附加信息。表4 Nic 参数是否必选参数类型描述 ip_address 否 String IP地址。 subnet_id 否 String 网卡对应的子网ID。表5 Volume 参数是否必选参数类型描述 type 是 String 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO size 是 Integer 磁盘容量，单位GB，数值约束为10的倍数。系统盘 minLength: 10，maxLength: 1024 数据盘 minLength: 10，maxLength: 32768 cluster_id 否 String 云服务器系统盘对应的存储池的ID。表6 WdhParam 参数是否必选参数类型描述 dedicated_host_id 否 String 云办公主机id。 tenancy 否 String 专属主机类型，目前只支持dedicated。 - dedicated：专属型 - shared：共享型。表7 CreateServerExtendParam 参数是否必选参数类型描述 charging_mode 否 String 计费模式，取值范围： prePaid-预付费，即包年包月； postPaid-后付费，即按需付费； period_type 否 Integer 周期类型 2：包月；3：包年* chargingMode为prePaid时生效且为必选值。 period_num 否 Integer 订购周期数，chargingMode为prePaid时生效且为必选值，periodNum为正整数，取值范围：说明： periodType=2（周期类型为月）时，取值为[1，9]。 periodType=3（周期类型为年）时，取值为[1，3]。 is_auto_renew 否 Boolean 是否是自动续订，默认不填为false。说明： false 不自动续订。 true 自动续订。 is_auto_pay 否 Boolean 下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。chargingMode为prePaid时生效，不传该字段时默认为客户手动支付。说明： true ：是（自动支付）。 false：否（需要客户手动支付）。

云桌面 WORKSPACE 服务器管理

云桌面 WORKSPACE-删除服务器:响应参数

响应参数状态码：200 表3 响应Body参数参数参数类型描述 job_id String 任务ID。状态码：400 表4 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：401 表5 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：403 表6 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：404 表7 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：405 表8 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：409 表9 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：500 表10 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。状态码：503 表11 响应Body参数参数参数类型描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

云桌面 WORKSPACE 服务器管理

云手机服务器 CPH-更换弹性公网IP:调用API更换弹性公网IP

调用API更换弹性公网IP 解绑弹性公网IP。请在管理控制台或者调用查询云手机服务器详情接口，查询服务器的EIP的ip地址（例如 122.9.102.xxx）。在弹性公网IP的管理控制台或者调用全量查询弹性公网IP列表接口，通过ip地址查询EIP的id。调用解绑弹性公网IP的解绑弹性公网IP接口进行解绑。调用示例如下： curl -i -k -X POST https://{Endpoint}/v3/{project_id}/eip/publicips/{eip_id}/disassociate-instance -H "Content-Type: application/json" -H "X-Auth-Token: ${token}" 绑定弹性公网IP。严格来讲弹性公网IP实际是绑定到port的，存在空闲port的机器可以进行绑定操作。根据第1步的指导查询到要绑定的弹性公网IP的id，这个弹性公网IP需要是未绑定状态。根据CPH的server_id调用查询端口列表接口，查询出服务器的所有port。调用示例如下： curl -i -k -X GET https://{Endpoint}/v1/{project_id}/ports?instance_id={cph_server_id} -H "Content-Type: application/json" -H "X-Auth-Token: ${token}" 根据port_id调用查询EIP列表接口查询弹性公网IP，可以一次传入一个或多个port_id进行查询，如果哪个port查不到弹性公网IP，则说明它可以绑定弹性公网IP。调用示例如下： curl -i -k -X GET https://{Endpoint}/v1/{project_id}/publicips?port_id={port_id1}\&port_id={port_id2}\&port_id={port_id3} -H "Content-Type: application/json" -H "X-Auth-Token: ${token}" 对于没有绑定弹性公网IP的port，可以调用绑定弹性公网IP接口，绑定弹性公网IP。调用示例如下： curl -i -k -X POST https://{Endpoint}/v3/{project_id}/eip/publicips/{eip_id}/associate-instance -H "Content-Type: application/json" -H "X-Auth-Token: ${token}" -d '{"publicip":{"associate_instance_id":"{port_id}","associate_instance_type":"PORT"}}'

云手机服务器 CPH 云手机服务器管理

VR云渲游平台 CVR-获取指定云服务器上的应用列表:响应参数

响应参数状态码为200时表2 响应Body参数参数参数类型描述 applications Array of objects 应用列表信息，详情请参见表3。表3 application字段数据结构说明参数参数类型描述 id String 应用ID。应用的唯一标识，格式为UUID。 name String 应用名称。 status String 云服务器上应用的安装状态。安装状态枚举值： waitinstall：等待安装 installing：安装中 failure：安装失败 launch：运行中 unlaunch：未运行 create_time String 应用创建时间。时间格式例如：2020-05-20T03:30:52Z package_size String 在云服务器上应用的安装包大小。 install_progress String 在云服务器上应用的安装任务进度。如：0.86 说明：总进度为1。状态码为400时表4 响应Body参数参数参数类型描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。

VR云渲游平台 CVR 云服务器管理

VR云渲游平台 CVR-获取指定云服务器上的应用列表:响应示例

响应示例状态码为200时 OK { "applications":[ { "id": "4d00636c-6540-11eb-b54a-fa1640a9b002", "name": "testcxcx", "status": "unlaunch", "create_time": "2021-02-02T10:20:42Z", "package_size": "99.27MB", "install_progress": "0.56" }} 状态码为400时 { "error_code" : "string", "error_msg" : "string" }

VR云渲游平台 CVR 云服务器管理

云客服-修改文件服务器接口:报文样例

报文样例该接口的请求消息体举例如下： { "userName":"WANGWU", "serverInfo":{ "ip":"5.9.11.11", "port":"22", "filePath":"/home/sftp" }, "serverPwd":"******"} 该接口的响应消息体举例如下： {"returnCode": "0200000","resultCode": "0200000","resultDesc": "success","returnDesc": "success"}

云客服文件服务器管理接口

云客服-修改文件服务器接口:接口URI

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/{serverId}/updateServer 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。表1 URL中携带的参数说明序号参数名参数类型是否必选说明 1 vdnId int True 虚拟呼叫中心ID。取值的类型为整数，取值范围为1～9999。 2 serverId String True 文件服务器ID

云客服文件服务器管理接口

云客服-修改文件服务器接口:请求说明

请求说明表2 请求消息头参数序号名称参数类型是否必选说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。表3 请求消息体参数说明序号参数名参数类型是否必选说明 1 serverInfo Object True 文件服务器信息。 2 userName String True 用户名 3 serverPwd String False 服务密码。明文传递，后台密文保存，当serviceInfo.IP与原有IP值不一致时，必传表4 serverInfo参数说明序号参数名参数类型是否必选说明 1 ip String True 文件服务器IP。 2 port String True port 3 filePath String True 文件服务器默认路径示例：/home/sftp

云客服文件服务器管理接口

云客服-修改文件服务器接口:错误结果码

错误结果码表6 错误原因码说明序号错误码说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 服务器配置信息不存在。 2 0200033 外呼数据不存在。 3 0200034 子状态与业务结果不匹配。 4 02000001 参数值为空 5 02000002 参数包含非法字符 6 02000003 参数长度不能大于规定长度 7 02000004 参数长度不能小于规定长度 8 02000005 参数长度需要介于规定长度之间 9 02000006 参数值类型不正确 10 02000007 参数值大小不正确 11 02000008 参数转换异常，请检查请求参数 12 02000009 参数组合不正确，请检查请求参数 13 02000010 hour和minute必须同时存在 14 02000011 参数个数不能大于规定个数

云客服文件服务器管理接口

云服务器内容精选

服务器管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线