华为云用户手册

响应示例 状态码：200 成功响应。 { "availability_zones" : [ { "availability_zone" : "cn-north-7a", "display_name" : "cn-north-7a", "i18n" : { "en_us" : "AZ1", "zh_cn" : "可用区1" }, "sold_out" : { "products" : [ ] }, "product_ids" : [ ], "visible" : true, "default_availability_zone" : false }, { "availability_zone" : "cn-north-7b", "display_name" : "cn-north-7b", "i18n" : { "en_us" : "AZ2", "zh_cn" : "可用区2" }, "sold_out" : { "products" : [ ] }, "product_ids" : [ ], "visible" : true, "default_availability_zone" : false }, { "availability_zone" : "cn-north-7c", "display_name" : "cn-north-7c", "i18n" : { "en_us" : "AZ3", "zh_cn" : "可用区3" }, "sold_out" : { "products" : [ ] }, "product_ids" : [ ], "visible" : true, "default_availability_zone" : false } ], "total_count" : 3 }

响应参数 状态码：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 错误描述。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 time_zones Array of Timezones objects 时区列表。 表5 Timezones 参数 参数类型 描述 time_zone_desc String 时区描述。 time_zone String 时区偏移量。 time_zone_name String 时区地名。 time_zone_desc_us String 时区英文描述。 time_zone_desc_cn String 时区中文描述。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 时区配置响应。 { "time_zones" : [ { "time_zone_desc" : "(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi, Taipei", "time_zone" : "GMT+08:00", "time_zone_name" : "Asia/Shanghai", "time_zone_desc_us" : "(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi, Taipei", "time_zone_desc_cn" : "(GMT+08:00) 北京, 重庆, 香港特别行政区, 乌鲁木齐, 台北" } ] }

请求示例 { "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" } } }

响应参数 状态码：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 错误描述。

请求参数 表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个字符。 为空或者*号表示任意匹配。

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

请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-servers/35998d9a-14f2-48fc-832b-6fc0074dc8f8/actions/change-image { "image_id" : "35998d9a-14f2-48fc-832b-6fc0074dc8f8", "image_type" : "private", "os_type" : "Windows", "image_product_id" : "35998d9a-14f2-48fc-832b-6fc0074dc8f8", "update_access_agent" : true }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 image_id 是 String 镜像id，要求与服务器原有镜像id不相同。 image_type 是 String 镜像类型： gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他 os_type 是 String 系统类型，当前仅支持Windows。 Linux - Windows - Other - image_product_id 否 String 镜像的产品id，当镜像是市场镜像时候，该字段必传。 update_access_agent 否 Boolean 是否自动升级hda版本。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码：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 错误描述。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码：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 错误描述。

响应参数 状态码：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 错误描述。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码：200 成功响应。 { "count" : 1, "items" : [ { "id" : "94b8e5c7-008f-40d7-b59a-084de3638286", "name" : "user-file-persistent", "storage_metadata" : { "storage_handle" : "sfs-tmp", "storage_class" : "sfs", "name" : "sfs-tmp", "region" : "cn-north-5", "export_location" : "https://sfs3.cn-****myhuaweicloud.com:443" }, "create_time" : "2023-06-08T07:08:09.412Z", "user_claim_count" : 0, "share_claim_count" : 0 } ] }

URI GET /v1/{project_id}/persistent-storages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 storage_id 否 String WKS存储ID。 name 否 String 查询名称，模糊匹配。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of PersistentStorage objects 存储列表。 表5 PersistentStorage 参数 参数类型 描述 id String WKS存储ID。 name String 名称。 storage_metadata StorageMetadata object 存储定义。 create_time String 创建时间。 user_claim_count Integer 个人目录声明数量。 share_claim_count Integer 共享目录声明数量。 表6 StorageMetadata 参数 参数类型 描述 storage_handle String SFS文件系统名称。 storage_class String 存储类型： sfs - sfs3.0存储。 name String 名称。 region String 所在区域。 export_location String 访问地址:protocol://[bucket-name].sfs3.[region-name].myhuaweicloud.com:port。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码：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 错误描述。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求示例 PUT /v2/fb2e5ec048384c8f9469d22db0037908/sites/fd5225ef-89f5-4921-9ab0-08fdbdd696fe/subnet-ids { "subnet_ids" : [ "string" ], "vpc_config_infos" : [ { "used_subnet_ids" : [ "string" ], "vpc_id" : "string", "subnet_ids" : [ "string" ], "default_access_vpc" : true } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务id。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：503 表10 响应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参数 参数 是否必选 参数类型 描述 subnet_ids 否 Array of strings 业务子网id。

请求示例 { "resources" : [ { "add_volumes" : { "service_id" : "string", "volumes" : [ { "type" : "SSD", "size" : 10, "cluster_id" : "c950ee97-587c-4f24-8a74-3367e3da570f" } ] }, "cloud_service_console_url" : "http://10.*.*.0:8003/v1/{project_id}/bundles/services/create", "create_services" : { "availability_zone" : "cn-north-5a", "data_volumes" : [ { "type" : "SSD", "size" : 10, "cluster_id" : "c950ee97-587c-4f24-8a74-3367e3da570f" } ], "nics" : [ { "ip_address" : "string", "subnet_id" : "197c1aa4-2611-48bd-a3af-ac4ce2c17c4c" } ], "ou_name" : "string", "product_id" : "workspacehost.s.large2.p01", "flavor_id" : "c3.large.4", "os_type" : "Windows", "root_volume" : { "type" : "SSD", "size" : 10, "cluster_id" : "c950ee97-587c-4f24-8a74-3367e3da570f" }, "server_group_id" : "1", "service_type" : "string", "subnet_id" : "197c1aa4-2611-48bd-a3af-ac4ce2c17c4c", "vpc_id" : "string", "security_groups" : [ { "id" : "string", "name" : "string" } ], "update_access_agent" : "true" }, "is_auto_renew" : 1, "period_num" : 3, "period_type" : 3, "subscription_num" : 3 } ], "type" : "createApps" }

响应参数 状态码：200 表10 响应Body参数 参数 参数类型 描述 order_id String 订单ID。 状态码：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 错误描述。 状态码：500 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of Resource objects 包周期资源对象。 type 是 String createApps【添加云应用】。 表4 Resource 参数 是否必选 参数类型 描述 add_volumes 否 AddVolumes object 磁盘订单请求。 cloud_service_console_url 否 String 支付后跳转的地址。 create_services 是 CreateServices object 云服务产品下单实体。 is_auto_renew 否 Integer 订购关系当前是否是自动续费：0 否 1 是。 period_num 否 Integer 订购周期数取值大于0。 period_type 否 Integer 包周期订单订购周期类型：2：月；3：年；4：包小时（仅限带宽加油包购买场景使用）5：绝对时间；（追加附属资源场景使用，比如主机上追加云硬盘）6：一次性（chargingMode=1 一次性计费场景使用），必填。 subscription_num 是 Integer 订购数量。 表5 AddVolumes 参数 是否必选 参数类型 描述 service_id 否 String 服务ID。 volumes 否 Array of Volume objects 订单的磁盘信息列表。 表6 CreateServices 参数 是否必选 参数类型 描述 availability_zone 否 String 可用分区。 说明： 将服务创建到指定的可用分区，如果不指定则使用系统随机的可用分区。 获取方式详见可用区管理ListAvailabilityZone："GET /v1/{project_id}/availability-zone"。 data_volumes 否 Array of Volume objects 数据盘。 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 Linux Windows root_volume 是 Volume object 默认系统卷信息 size取值：minLength: 10，maxLength: 1024。 server_group_id 是 String 服务器组ID, 云应用创建服务组时生成。 service_type 否 String 云服务类型， 云桌面 固定为DEDICATED。 subnet_id 是 String 子网ID。 vpc_id 是 String 自动开户的时候,用于LiteAs第一次开户传进来。 security_groups 否 Array of SecurityGroup objects 服务器使用的安全组，如果不指定则默认使用服务器代理中指定的安全组。 ⚠ 警告: 预留属性，目前未使用 update_access_agent 否 Boolean 是否自动升级hda版本。 表7 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。 表8 Nic 参数 是否必选 参数类型 描述 ip_address 否 String IP地址。 subnet_id 否 String 网卡对应的子网ID。 表9 SecurityGroup 参数 是否必选 参数类型 描述 id 否 String 安全组ID。 name 否 String 安全组名称。

响应参数 状态码：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 错误描述。 状态码：415 表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 错误描述。

响应示例 状态码：200 查询OpenStack环境中的镜像响应。 { "total_count" : 1, "images" : [ { "id" : "d6b368bc-a24d-4fb5-a8fb-727356a53f33", "image_type" : "gold", "os_type" : "Linux", "os_version" : "EulerOS 2.2 64bit", "disk_format" : "qcow2", "name" : "Euler_Online_Tenant_vAG", "min_ram" : 0, "min_disk" : 50 }, { "id" : "bef99a44-2b6a-4ef9-b1a2-204a4910e374", "image_type" : "gold", "os_type" : "Linux", "os_version" : "EulerOS 2.5 64bit", "disk_format" : "qcow2", "name" : "FA-LZ-x86vAG-801temp", "min_ram" : 0, "min_disk" : 60 } ] }

URI GET /v2/{project_id}/images 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 os_type 否 String 产品镜像的操作系统类型，如Windows。 image_type 否 String 镜像类型。 -gold 公共镜像 -private 私有镜像 platform 否 String 镜像系统类型,如Windows。 architecture 否 String 镜像架构：x86。 package_type 否 String 套餐系列。 image_id 否 String 镜像Id。 limit 否 Integer 每页数量，范围0-100，默认100。 offset 否 Integer 偏移量,默认0。 sort_field 否 String 用于排序，表示按照哪个字段排序。取值为镜像属性name、created_at字段，默认为name。 sort_type 否 String 用于排序，表示升序还是降序，取值为asc和desc。与sort_field一起组合使用，默认为升序asc。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 images Array of ImageInfo objects 云桌面支持的产品镜像列表。 total_count Integer 对象总数。 表5 ImageInfo 参数 参数类型 描述 id String 镜像ID。 image_type String 镜像类型，目前支持以下类型： 公共镜像：gold 私有镜像：private。 os_type String 操作系统类型，目前取值Linux， Windows，Other。 architecture String 操作系统架构，目前取值arm，x86。 os_version String 操作系统具体版本。 disk_format String 镜像格式，目前支持vhd，raw，qcow2，zvhd2格式。 name String 镜像名称。 min_ram Integer 镜像运行需要的最小内存，单位为MB。参数取值依据弹性云服务器的规格限制，一般设置为0。 min_disk Integer 镜像运行需要的最小磁盘，单位为GB 。取值为40～1024GB。 product_code String 镜像的产品编码。 created_at String 创建时间。格式为UTC时间。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 查询策略应用对象的响应。 { "targets" : [ { "target_id" : "S-1-5-21-1065092785-1316984780-3147557180-9999", "target_type" : "USER", "target_name" : "All-Targets-123" }, { "target_id" : "192.168.1.1", "target_type" : "CLIENTIP", "target_name" : "192.168.1.1" } ] }

URI GET /v2/{project_id}/policy-groups/{policy_group_id}/targets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 policy_group_id 是 String 策略组id。 表2 Query参数 参数 是否必选 参数类型 描述 target_type 否 String 应用对象的类型。 INSTANCE：表示桌面。 USER：表示用户。 OU：表示组织单元。 CLIENTIP：终端IP地址。 target_name 否 String 对象名称，支持模糊查询。 limit 否 Integer 每页数量。范围0-1000。 offset 否 String 偏移量。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 targets Array of Target objects 应用对象列表。 total_count Integer 用户列表数量。 表5 Target 参数 参数类型 描述 target_id String 对象ID。 target_name String 对象名称。 target_type String 对象类型。 INSTANCE：表示桌面。 target_id：为桌面的SID。 target_name：为桌面name。 USER：表示用户。 target_id：为用户ID。 target_name：为用户name。 USERGROUP：表示用户组。 target_id：为用户组ID。 target_name：为用户组name。 CLIENTIP：终端IP地址。 target_id：终端IP地址。 target_name：终端IP地址。 OU：组织单元。 target_id：OUID。 target_name：OU名称。 DESKTOPSPOOL：表示桌面池。 target_id：为桌面池的ID。 target_name：为桌面池name。 ALL：表示所有桌面。 target_id：default-apply-all-targets。 target_name：All-Targets。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。