云服务器内容精选

  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 id String 规则ID。 name String 规则名称。 description String 规则描述。 rule Rule object 规则信息。 rule_source String 规则来源。 create_time String 创建时间。 update_time String 更新时间。 表8 Rule 参数 参数类型 描述 scope String 规则范围: PRODUCT - 产品 PATH - 路径 product_rule ProductRule object 产品规则信息,进程名称、产品名称、发布者的各项都需要匹配,为空或者表示任意匹配。 例如: 发布者: 产品名称:Huawei 进程名称:* 只要产品名称是Huawei的就可以认为是匹配的。 path_rule PathRule object 路径规则信息,限制对应路径及子路径 表9 ProductRule 参数 参数类型 描述 identify_condition String 识别条件。 publisher String 发布者名称: 名称允许可见字符或空格,不可为全空格。 长度0~1024个字符。 为空或者*号表示任意匹配。 product_name String 产品名称: 名称允许可见字符或空格,不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 process_name String 进程名称: 名称允许可见字符或空格,不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 support_os String 操作系统类型,仅内置规则存在该字段。 名称允许可见字符或空格,不可为全空格。 长度0~128个字符。 version String 版本号: 名称允许可见字符或空格,不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 product_version String 产品版本号: 允许可见字符。 长度0~128个字符。 表10 PathRule 参数 参数类型 描述 path String 完整路径: 名称允许可见字符或空格,不可为全空格。 长度0~512个字符。 为空或者*号表示任意匹配。 状态码: 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 401 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 403 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 404 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 405 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求示例 { "name" : "Huawei", "description" : "test。", "rule" : { "scope" : "PRODUCT", "product_rule" : { "identify_condition" : "productName", "publisher" : null, "product_name" : "HUAWEI", "process_name" : "Huawei.exe", "support_os" : "Windows", "version" : "1.0.0.1", "product_version" : "1.0.0.1" }, "path_rule" : { "path" : "D:\\\\tmp" } } }
  • 响应示例 状态码: 200 成功响应。 { "id" : "string", "name" : "string", "description" : "string。", "rule" : { "scope" : "PRODUCT", "product_rule" : { "identify_condition" : "productName", "publisher" : null, "product_name" : "HUAWEI", "process_name" : "Huawei.exe", "support_os" : "Windows", "version" : "1.0.0.1", "product_version" : "1.0.0.1" }, "path_rule" : { "path" : "D:\\\\tmp" } }, "rule_source" : "string", "create_time" : "2024-12-25T07:03:30.065Z", "update_time" : "2024-12-25T07:03:30.065Z" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 规则名称: 名称允许可见字符或空格,不可为全空格。 长度1~64个字符。 rule 是 Rule object 规则信息。 表4 Rule 参数 是否必选 参数类型 描述 scope 是 String 规则范围: PRODUCT - 产品 PATH - 路径 product_rule 否 ProductRule object 产品规则信息,进程名称、产品名称、发布者的各项都需要匹配,为空或者表示任意匹配。 例如: 发布者: 产品名称:Huawei 进程名称:* 只要产品名称是Huawei的就可以认为是匹配的。 path_rule 否 PathRule object 路径规则信息,限制对应路径及子路径 表5 ProductRule 参数 是否必选 参数类型 描述 identify_condition 否 String 识别条件。 publisher 否 String 发布者名称: 名称允许可见字符或空格,不可为全空格。 长度0~1024个字符。 为空或者*号表示任意匹配。 product_name 否 String 产品名称: 名称允许可见字符或空格,不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 process_name 否 String 进程名称: 名称允许可见字符或空格,不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 support_os 否 String 操作系统类型,仅内置规则存在该字段。 名称允许可见字符或空格,不可为全空格。 长度0~128个字符。 version 否 String 版本号: 名称允许可见字符或空格,不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 product_version 否 String 产品版本号: 允许可见字符。 长度0~128个字符。 表6 PathRule 参数 是否必选 参数类型 描述 path 否 String 完整路径: 名称允许可见字符或空格,不可为全空格。 长度0~512个字符。 为空或者*号表示任意匹配。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 任务ID。 job_type String 任务类型。 begin_time String 任务开始时间。 end_time String 任务结束时间。 status String 任务状态。 job_error_code String 任务错误码。 fail_reason String 任务失败原因。 sub_jobs_total Integer 子任务总数。 sub_jobs Array of JobDetailInfo objects 子任务列表。 表4 JobDetailInfo 参数 参数类型 描述 id String 子任务ID。 job_type String 任务类型。 entities JobEntities object 任务。 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String 任务状态。 error_code String 任务执行失败时的错误码。 fail_reason String 任务失败原因。 host String 任务执行的服务器IP。 project_id String 项目ID。 job_id String 任务ID。 process Integer 任务进度。 attach_user String 关联用户。 entity String 操作对象。 ip_address String ip地址。 表5 JobEntities 参数 参数类型 描述 desktop_id String 桌面ID。 product_id String 套餐ID。 user_name String 用户名。 desktop_name String 桌面名称。 ip_address String ip地址。 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: default 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 响应示例 状态码: 200 成功响应。 { "id" : "x-xx-xxx", "tenant_id" : "xxx-xx-x-xx", "name" : "xxx.exe", "version" : "v1.1.1", "description" : "测试应用。", "authorization_type" : "ALL_USER", "app_file_store" : { "store_type" : "OBS", "bucket_store" : { "bucket_name" : "wks-appcenter-xxxx", "bucket_file_path" : "app-file/xxxx.exe" }, "file_link" : "https://host-addresss/xxxxx.jpg" }, "app_icon_url" : "https://host-addresss/xxxxx", "install_type" : "QUIET_INSTALL", "install_command" : "${FILE_PATH} /S", "uninstall_command" : "msiexec /uninstall ${FILE_PATH} /quiet", "support_os" : "Windows", "status" : "NORMAL", "application_source" : "CUSTOM", "create_time" : "2024-12-25T06:58:19.765Z", "catalog_id" : 1, "catalog" : "其他", "install_info" : "安装信息" }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 id String 唯一标识。 tenant_id String 租户id。 name String 应用名称。 version String 版本号。 description String 描述。 authorization_type String ALL_USER - 全部用户 ASSIGN_USER - 授权指定用户 app_file_store FileStoreLink object 应用存储信息。 app_icon_url String 应用图标路径。 install_type String 安装方式: QUIET_INSTALL - 静默安装。 安装命令(静默安装命令),例: ${FILE_PATH} /S。 UNZIP_INSTALL - 解压安装。 例: unzip ${FILE_PATH}。 GUI_INSTALL - 用户通过GUI界面安装。 install_type为QUIET_INSTALL、UNZIP_INSTALL时install_command非空。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 install_command String 安装命令(静默安装命令)。 例: ${FILE_PATH} /S。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 uninstall_command String 卸载命令(静默卸载命令)。 例: msiexec /uninstall ${FILE_PATH} /quiet。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 support_os String 系统类型: Linux - Windows - Other - status String 应用状态(正常、禁用) 'NORMAL' - 正常 'FORBIDDEN' - 禁用状态 application_source String 应用来源: CUSTOM - 用户上传 SYSTEM - 内置应用 MARKET - 市场应用 create_time String 应用创建时间。 catalog_id String 分类ID。 catalog String 分类名称。 install_info String 安装信息。 表7 FileStoreLink 参数 参数类型 描述 store_type String 存储方式: OBS - OBS桶存储。 LINK - 外部存储,使用的可访问下载链接。 bucket_store BucketStore object OBS桶存储。 file_link String 文件下载完整路径。 表8 BucketStore 参数 参数类型 描述 bucket_name String 桶名称固定格式:wks-appcenter-{project_id}; 需先调用桶授权接口进行授权。 bucket_file_path String OBS对象路径。 注: bucket_file_path是对象在obs中的完整路径,不能以/开头。 例如桶存在如下目录结构的数据。 Bucket: ├─dir1 | ├─object1.txt | └─object2.txt └─object3.txt Object1的路径: dir1/object1.txt Object2的路径: dir1/object2.txt Object3的路径: object3.txt 状态码: 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 错误描述。 状态码: 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 405 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求示例 { "name" : "notepad++.exe", "version" : "v1.1.1", "description" : "xxx。", "app_file_store" : { "store_type" : "OBS", "bucket_store" : { "bucket_name" : "wks-appcenter-xxxx", "bucket_file_path" : "app-file/xxxx.exe" }, "file_link" : "https://host-addresss/xxxxx.jpg" }, "app_icon_url" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8 /w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==", "install_type" : "QUIET_INSTALL", "authorization_type" : "ALL_USER", "install_command" : "${FILE_PATH} /S", "uninstall_command" : "msiexec /uninstall ${FILE_PATH} /quiet", "support_os" : "Windows", "catalog_id" : "xxxx-xxx-xxxx", "status" : "NORMAL", "install_info" : "xxxx-xxx-xxxx" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 应用名称,名称需满足如下规则: 名称允许可见字符或空格,不可为全空格。 长度1~128个字符。 version 否 String 版本号。 description 否 String 描述。 app_file_store 否 FileStoreLink object 文件存储路径支持OBS或者外部链接,store_type指定实际生效的配置,bucket_store和file_link必须设置其一。 app_icon_url 否 String 图片的路径,支持使用可访问的URL地址或DataURIscheme。 可访问的URL - https://xxx.x.xx.x/xxx/xx.jpg。 DataURIscheme - data;image/png;base64,iVBORw0KGgoAAAANS; 注意使用dataURLStream时,最多支持约xxKB大小的图片,且必须是png格式。 install_type 否 String 安装方式: QUIET_INSTALL - 静默安装。 安装命令(静默安装命令),例: ${FILE_PATH} /S。 UNZIP_INSTALL - 解压安装。 例: unzip ${FILE_PATH}。 GUI_INSTALL - 用户通过GUI界面安装。 install_type为QUIET_INSTALL、UNZIP_INSTALL时install_command非空。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 authorization_type 否 String ALL_USER - 全部用户 ASSIGN_USER - 授权指定用户 install_command 否 String 安装命令(静默安装命令)。 例: ${FILE_PATH} /S。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 uninstall_command 否 String 卸载命令(静默卸载命令)。 例: msiexec /uninstall ${FILE_PATH} /quiet。 预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。 support_os 否 String 系统类型: Linux - Windows - Other - catalog_id 否 String 分类ID。 status 否 String 应用状态(正常、禁用) 'NORMAL' - 正常 'FORBIDDEN' - 禁用状态 install_info 否 String 安装信息。 表4 FileStoreLink 参数 是否必选 参数类型 描述 store_type 是 String 存储方式: OBS - OBS桶存储。 LINK - 外部存储,使用的可访问下载链接。 bucket_store 否 BucketStore object OBS桶存储。 file_link 否 String 文件下载完整路径。 表5 BucketStore 参数 是否必选 参数类型 描述 bucket_name 否 String 桶名称固定格式:wks-appcenter-{project_id}; 需先调用桶授权接口进行授权。 bucket_file_path 否 String OBS对象路径。 注: bucket_file_path是对象在obs中的完整路径,不能以/开头。 例如桶存在如下目录结构的数据。 Bucket: ├─dir1 | ├─object1.txt | └─object2.txt └─object3.txt Object1的路径: dir1/object1.txt Object2的路径: dir1/object2.txt Object3的路径: object3.txt
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 items Array of Catalog objects 应用分类信息。 表4 Catalog 参数 参数类型 描述 id String 唯一标识ID。 catalog_zh String 分类描述(中文)。 catalog_en String 分类描述(英文)。 状态码: 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 错误描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码: 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 bandwidth_name 否 String 云办公带宽名称。 bandwidth_size 否 Integer 云办公带宽大小。 enterprise_project_id 否 String 企业项目ID,默认"0。" charge_mode 否 String 计费模式 wks_bandwidth:按带宽计费。 free: 不计费,不支持包周期订购。 wks_traffic:按流量计费
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务id。 状态码: default 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 order_id String 订单号,下单成功时返回订单ID。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: 409 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 类型 resizeDesktops(变更规格)、expandVolumes(扩容磁盘)。 period_type 否 Integer 周期类型,2:包月;3:包年。 period_num 否 Integer 周期数。 resize_product_id 否 String 变更后规格产品ID,当是resizeDesktops,必传。 expand_volume_id 否 String 扩容的云硬盘的ID,当是expandVolumes,必传。 expand_new_size 否 Integer 扩容后云硬盘的总大小,当是expandVolumes,必传。范围10-32760,大小为10的倍数。 new_quantity 否 Integer 专享主机变更桌面数后桌面路数的总大小,当是jobType是resizeExclusiveLites,必传。 exclusive_lites_product_id 否 String 专享主机桌面数的productId,当是resizeExclusiveLites,必传。 cloud_service_console_url 否 String 支付后跳转url。 enterprise_project_id 否 String 企业项目ID。 extend_param 否 OrderExtendParam object 订单的扩展参数。 表4 OrderExtendParam 参数 是否必选 参数类型 描述 is_auto_pay 否 String 是否自动付款。true:自动支付; false:不自动支付;默认false。
  • 响应示例 状态码: 200 查询可用分区列表响应。 { "support_type" : [ "string" ], "default_type" : "string", "azs" : { "additionalProp1" : [ { "availability_zone" : "string", "i18n" : { "zh_cn" : "string", "en_us" : "string" }, "default_availability_zone" : true } ], "additionalProp2" : [ { "availability_zone" : "string", "i18n" : { "zh_cn" : "string", "en_us" : "string" }, "default_availability_zone" : true } ], "additionalProp3" : [ { "availability_zone" : "string", "i18n" : { "zh_cn" : "string", "en_us" : "string" }, "default_availability_zone" : true } ] } }