华为云用户手册

  • 响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of AppConnectionInfo objects 应用使用记录列表。 表6 AppConnectionInfo 参数 参数类型 描述 id String 应用连接唯一标识ID。 sid String 应用服务器sid。 machine_name String 应用服务器名称。 user_name String 登录用户。 app_group_name String 应用组名称。 app_group_id String 应用组ID。 app_name String 应用名称。 brokering_time String 登录应用时间。 failed_code String 连接失败状态码。 connection_failure_reason String 连接失败原因。 client_mac String 客户端Mac。 client_name String 客户端名称。 client_ip String 客户端ip。 client_version String 客户端版本。 client_type String 客户端操作系统类型。 agent_version String aps hda版本。 vm_ip String 应用服务器ip。 wi_ip String 连接IP。 tenant_id String 租户id。 virtual_ip String 会话虚拟ip。 public_ip String 客户端出口ip。 transaction_id String 事务id。 end_time String 登录应用结束时间。 aps_instance_id String aps服务器ID。 aps_instance_name String aps服务器名称。 aps_host_id String wdh专属主机ID。 primary_server_group_id String 主服务器组ID。 secondary_server_group_id String 主服务器组ID。 状态码: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 错误描述。 状态码:415 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 主键。 sid 否 String 应用服务器sid。 machine_name 否 String 应用服务器名称。 user_name 否 String 登录用户,模糊查询。 app_group_name 否 String 应用组名称。 app_group_id 否 String 应用组id。 app_name 否 String 应用名称,模糊查询。 failed_code 否 String 连接失败状态码。 connection_failure_reason 否 String 连接失败原因。 client_name 否 String 客户端名称。 client_version 否 String 客户端版本。 client_type 否 String 客户端操作系统类型。 agent_version 否 String aps hda版本。 vm_ip 否 String 应用服务器ip。 wi_ip 否 String 连接IP。 public_ip 否 String 客户端出口ip。 tenant_id 否 String 租户id。 brokering_start_time 否 String 登录应用开始时间,格式 2022-10-31 08:07:39。 brokering_end_time 否 String 登录应用结束时间,格式 2022-10-31 08:07:39。 virtual_ip 否 String 会话虚拟ip。
  • 响应参数 状态码: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 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 items 是 Array of strings 批量请求的服务器ID列表,一次请求数量区间 [1, 20]。 type 是 String 停机类型: SOFT - 普通 HARD - 强制
  • 响应参数 状态码:200 表14 响应Body参数 参数 参数类型 描述 order_id String 订单号,下单成功时返回订单ID。 状态码:400 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:409 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:500 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 请求示例 { "enterprise_project_id" : "0", "hour_package_resources" : [ { "period_type" : 255, "period_num" : 2147483647, "is_auto_renew" : 0, "create_desktops" : { "desktop_type" : "string", "availability_zone" : "string", "product_id" : "string", "flavor_id" : "string", "share_resource_sku" : "string", "image_type" : "private", "image_id" : "string", "root_volume" : { "type" : "string", "size" : 32760, "cluster_id" : "string" }, "data_volumes" : [ { "type" : "string", "size" : 32760, "cluster_id" : "string" } ], "nics" : [ { "subnet_id" : "string", "ip_address" : "string" } ], "security_groups" : [ { "id" : "string", "name" : "string" } ], "desktops" : [ { "user_name" : "string", "user_email" : "string", "user_phone" : "string", "user_group" : "string", "computer_name" : "string", "os_host_name" : "string", "nics" : [ { "subnet_id" : "string", "ip_address" : "string" } ], "ou_name" : "string", "desktop_name_prefix" : "strin" } ], "desktop_name" : "string", "desktop_ips" : [ "string" ], "size" : 100, "email_notification" : "true", "enterprise_id" : "string", "enterprise_project_id" : "0", "order_id" : "string", "ou_name" : "string", "vpc_id" : "string", "subnet_ids" : [ "string" ], "tags" : [ { "key" : "string", "value" : "" } ], "scheduler_hints" : { "tenancy" : "string", "dedicated_host_id" : "string" }, "desktop_isv" : "DEFAULT", "access_mode" : "INTERNET", "apply_shared_vpc_dedicated_param" : { "address" : "string", "port" : 65535, "availability_zone" : [ "string" ] }, "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16", "eip" : { "id" : "string", "type" : "string", "charge_mode" : "string", "bandwidth_size" : 2000 }, "adn" : { "charge_mode" : "string", "bandwidth_size" : 2000 }, "exclusive_host_id" : "string", "desktop_name_policy_id" : "string", "hour_package_product_id" : "string", "hour_package_offering_id" : "string", "root_resource_ids" : [ "string" ], "inst_info_ids" : [ "string" ] } } ], "order_id" : "string", "promotion_id" : "string", "promotion_plan_id" : "string", "promotion_info" : "string", "extend_param" : { "is_auto_pay" : "string" } }
  • 响应示例 状态码:200 成功响应。 { "count" : 0, "items" : [ { "id" : "1", "job_type" : "createServer", "begin_time" : "2022-03-07T10:40:43.858Z", "end_time" : "2022-03-07T10:40:43.858Z", "status" : "WAITING", "sub_jobs_total" : 10 } ] }
  • URI GET /v1/{project_id}/image-server-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String job状态: WAITING - 等待 RUNNING - 运行中 SUC CES S - 完成 FAILED - 失败 job_type 是 String job类型: CREATE_SERVER - 创建镜像实例 CREATE_SERVER_IMAGE - 构建镜像 DELETE_SERVER - 删除镜像实例 offset 否 Integer 查询的偏移量,默认值0。 limit 否 Integer 查询的数量,值区间[1-100],默认值10。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ImageJobInfo objects 任务信息列表,返回列表条目数量上限为分页的最大上限值。 表5 ImageJobInfo 参数 参数类型 描述 id String 任务ID。 job_type String job类型。 CREATE_SERVER - 创建镜像实例 CREATE_SERVER_IMAGE - 构建镜像 DELETE_SERVER - 删除镜像实例 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String job状态。 WAITING - 等待 RUNNING - 运行中 `SUCCESS - 完成 FAILED - 失败 sub_jobs_total Integer 子任务总数。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:405 表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 错误描述。
  • 响应示例 状态码:200 查询OU信息。 { "user_infos" : [ { "user_name" : "wksmanager", "expired_time" : "2022-12-17 00:00:00", "has_existed" : false }, { "user_name" : "wksmanager", "expired_time" : "-1", "has_existed" : false } ], "total_count" : 2 }
  • URI GET /v2/{project_id}/ou-users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 ou_dn 是 String OU的 域名 地址。 user_name 否 String 用户名,支持模糊查询。 has_existed 否 Boolean 用户是否已存在。 limit 否 Integer 用于分页查询,返回桌面数量限制。如果不指定,则返回所有符合条件的桌面。 offset 否 Integer 用于分页查询,查询的起始记录序号,从0开始。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 user_infos Array of AdOuUserInfo objects OU对象。 total_count Integer 用户数。 enable_create_count Integer 可以创建的用户数量。 表5 AdOuUserInfo 参数 参数类型 描述 user_name String 名称。 expired_time String 过期时间 -1代表永不过期。 has_existed Boolean 是否存在于用户列表。 状态码: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接口进行解密。
  • 响应参数 状态码: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 错误描述。
  • 响应参数 状态码: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 错误描述。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of UserMetric objects 用户统计指标。 表5 UserMetric 参数 参数类型 描述 username String 用户名称。 metric Array of Metric objects 桌面使用统计信息 user_usage - 用户使用时长(单位:秒),同一时间登录多台PC的话;相应的时间会累加 user_login_count - 用户登录次数(单位:次) user_login_success_count - 用户登录成功次数(单位:次) user_login_fail_count - 用户登录失败次数(单位:次) 表6 Metric 参数 参数类型 描述 metric_name String 指标名称。 metric_value Double 指标值。 状态码:400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码:401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码:500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v2/{project_id}/statistics/metrics/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 查询起始时间(0时区)。 end_time 是 String 查询截至时间(0时区)。 username 否 String 用户名(模糊匹配)。 usage_min_hours 否 Integer 使用时长最小值。 usage_max_hours 否 Integer 使用时长最大值 usage_min_hours和usage_max_hours同时存在时,usage_max_hours必须大于等于usage_min_hours sort_field 否 String 按照指标进行排序 user_usage - 按照用户使用时长排序 sort_type 否 String 按照指标进行排序的方向;需配合sort_field一起使用 DESC - 降序返回数据 ASC - 升序返回数据 offset 否 Integer 查询的偏移量,默认值0。 limit 否 Integer limit范围[1-100],默认值0。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 id String 创建OU的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接口进行解密。 状态码:405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:503 表11 响应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类型,如:application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 domain 是 String 域名称。 ou_name 是 String OU名称。 description 否 String 描述。
  • 响应示例 状态码:200 响应成功。 { "rule_id" : "xxxx-xxxx-xxxx", "metric_name" : "desktop_idle_duration", "threshold" : 30, "comparison_operator" : "", "interval" : 1, "enable" : true, "notify_object" : "urn:smn:REGION_ID:XXX-XXX-XXX:topicName" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 是 Array of strings 桌面id列表,最小为1,最大为100。 vpc_id 是 String 待切换VPC的ID。 subnet_id 是 String 待切换子网的ID。 security_group_ids 否 Array of strings 安全组ID列表。
  • 响应参数 状态码: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接口进行解密。 状态码:409 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:500 表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参数 参数 是否必选 参数类型 描述 site_id 否 String 站点ID。 nat_on 否 Boolean 是否开启nat映射。 nat_vag_maps 否 Array of UpdateNatMappingConfig objects NAT映射配置表。 表4 UpdateNatMappingConfig 参数 是否必选 参数类型 描述 nat_map_type 否 String NAT映射类型。 PORT:端口映射. HOST:地址映射,最多支持配置10个地址. nat_map_value 否 String nat_map_type为PORT时表示端口,取值9443/9445. nat_map_type为HOST时表示接入地址. nat_ip 否 String nat Ip。 nat_port 否 String nat端口,取值范围0-65535。 vag_ip 否 String vag Ip。 access_filter_type 否 Integer 0表示不开启,1表示开启。 enterprise_project_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接口进行解密。
  • 响应参数 状态码: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接口进行解密。
  • 响应参数 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码:500 表7 响应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的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 old_username 是 String 桌面关联原用户名,只传用户名,不带域信息。 new_username 是 String 桌面关联新用户名,只传用户名,不带域信息。 is_reboot 否 Boolean 桌面关联新用户名后是否重启虚拟机,默认不重启。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 是 Array of strings 桌面ID列表。 sub_resource_type 是 String 待删除附属资源类型。DESKTOP_SHARER:桌面协同资源。 order_id 否 String 订单ID。
  • 响应参数 状态码: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接口进行解密。
  • 响应参数 状态码: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接口进行解密。 状态码:500 表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参数 参数 是否必选 参数类型 描述 function_config 否 FunctionConfig object 租户个性配置。 表4 FunctionConfig 参数 是否必选 参数类型 描述 id 否 String 功能配置id。 name 否 String 功能配置名称。 status 否 String 功能配置开关的状态,表示开启还是关闭 ON/OFF。 - ON: 开启该功能 - OFF: 关闭该功能。 values 否 Array of MapObject objects 配置项列表,键值对格式。 表5 MapObject 参数 是否必选 参数类型 描述 key 否 String 配置项的键。 value 否 String 配置项对应的值。
共100000条