云服务器内容精选

  • 修订记录 发布日期 修订记录 2024-10-23 第十九次正式发布。 新增: 包年/包月模式购买桌面(按小时)章节内容。 2024-08-07 第十八次正式发布。 修改: 购买桌面中创建用户时的用户规则。 2023-12-01 第十七次正式发布。 新增: 登录桌面(浏览器方式)。 2023-09-20 第十六次正式发布。 新增: 包年/包月模式购买桌面池。 按需计费模式购买桌面池。 2023-07-03 第十五次正式发布。 新增: 登录桌面(软终端方式)中新增“第三方单点登录”章节内容。 2022-12-02 第十四次正式发布。 修改: 购买桌面时的网络配置中增加VPC网络选择的限制描述。涉及如下页面: 包年/包月模式购买桌面。 按需计费模式购买桌面。 2022-11-22 第十三次正式发布。 修改: 优化如下章节中邮件样式: 登录桌面(TC方式) 登录桌面(软终端方式) 登录桌面(移动终端方式) 登录桌面(TC方式)中增加TC登录说明。 2022-11-11 第十二次正式发布。 修改: 优化如下章节中镜像描述: 包年/包月模式购买桌面。 按需计费模式购买桌面。 2022-10-10 第十一次正式发布。 修改: 修改登录桌面(软终端方式)中mac操作系统版本。 2022-09-02 第十次正式发布。 修改: 包年/包月模式购买桌面新增续费操作。 按需计费模式购买桌面新增按需转包周期的参考链接。 2022-08-30 第九次正式发布。 修改: 包年/包月模式购买桌面、按需计费模式购买桌面修改桌面名称命名规则。 登录桌面(TC方式)、登录桌面(软终端方式)、登录桌面(移动终端方式)优化多因素认证配置描述。 2022-08-08 第八次正式发布。 修改: 包年/包月模式购买桌面、按需计费模式购买桌面更新项目配置及时长配置说明。 登录桌面(TC方式)、登录桌面(软终端方式)、登录桌面(移动终端方式)新增MFA登录配置。 2022-07-01 第七次正式发布。 修改: 优化登录页面的企业ID配置,涉及如下页面: 登录桌面(TC方式) 登录桌面(软终端方式) 登录桌面(移动终端方式) 2022-06-09 第六次正式发布。 修改: 优化用户名称规则,涉及如下页面: 包年/包月模式购买桌面 按需计费模式购买桌面 2022-05-31 第五次正式发布。 修改: 修改客户端名称,涉及如下页面: 登录桌面(TC方式) 登录桌面(软终端方式) 2022-04-29 第四次正式发布。 修改: 修改登录桌面(移动终端方式)登录界面。 2022-03-30 第三次正式发布。 修改: 购买方式简介中新增按需购买模式描述。 优化包年/包月模式购买桌面中镜像说明。 新增: 按需计费模式购买桌面 2022-02-28 第二次正式发布。 修改: 登录桌面(软终端方式)新增客户端获取方式及mac登录方式描述。 登录桌面(移动终端方式)新增客户端获取方式描述。 2022-01-05 第一次正式发布。
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: 405 表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接口进行解密。 状态码: 503 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 id_list 否 Array of strings 绑定策略ID列表
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result_list Array of DeleteTerminalsBindingDesktopsResult objects 需删除的策略ID列表 表5 DeleteTerminalsBindingDesktopsResult 参数 参数类型 描述 id String 需删除的策略ID delete_result_code String 删除操作的结果码 delete_result_msg String 删除操作的结果信息 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: 404 表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接口进行解密。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 users Array of UserInGroup objects 组关联的用户列表。 total_count Integer 用户列表中用户总数。 表5 UserInGroup 参数 参数类型 描述 id String 用户ID。 user_name String 桌面用户名。 user_email String 用户邮箱。 user_phone String 用户手机号。 total_desktops Integer 用户桌面数。 description String 用户描述。
  • 响应示例 状态码: 200 组关联的用户列表响应。 { "total_count" : 2, "users" : [ { "user_name" : "user1", "user_email" : "xx1@mail.com", "user_phone" : "18818008887", "id" : "8357fd328c62447d94e452bf49xxxx" }, { "user_name" : "user2", "user_email" : "xx2@mail.com", "user_phone" : "18818008888", "id" : "8357fd328c62447d94e452bf495xxxx" } ] }
  • URI GET /v2/{project_id}/groups/{group_id}/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 group_id 是 String 用户组ID。 表2 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 用户名支持模糊查询。 description 否 String 用户描述支持模糊查询。 active_type 否 String 激活类型。 USER_ACTIVATE:用户激活 ADMIN_ACTIVATE:管理员激活 limit 否 String 用于分页查询,返回桌面数量限制。如果不指定或为0,默认2000,最大2000。 offset 否 String 用于分页查询,查询的起始记录序号,从0开始。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 发送的实体的MIME类型,如:application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 用户组名称。 platform_type 是 String 用户组类型。 AD: AD域用户组 LOCAL: 本地liteAs用户组 description 否 String 用户组描述。
  • 响应参数 状态码: 201 表4 响应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接口进行解密。 状态码: 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参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 策略id mac 是 String 终端MAC地址 desktop_name 是 String 虚拟机名称 description 否 String 描述
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 desktop_used_info_list Array of DesktopUsedHoursInfo objects 桌面使用信息(以桌面Id划分)。 total_count Integer 总数。 表5 DesktopUsedHoursInfo 参数 参数类型 描述 desktop_id String 桌面Id。 desktop_username String 使用的用户。 used_info_list Array of DesktopUsedInfo objects 桌面使用时间列表。 表6 DesktopUsedInfo 参数 参数类型 描述 date String 日期,格式:yyyy-MM-dd(UTC时间)。 use_time String 总共在线时间单位:小时数(h),精确到两位小数,如:1.32。 状态码: default 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。
  • 响应示例 状态码: 200 查询使用桌面的时长响应。 { "desktop_used_info_list" : [ { "desktop_id" : "c6e6dbd7-c950-471d-a6a7-01d0fb62f450", "used_info_list" : [ { "date" : "2022-12-09", "use_time" : 12.62 }, { "date" : "2022-12-10", "use_time" : 2.62 }, { "date" : "2022-12-11", "use_time" : 1.02 }, { "date" : "2022-12-12", "use_time" : 0 }, { "date" : "2022-12-13", "use_time" : 0 }, { "date" : "2022-12-14", "use_time" : 3.87 }, { "date" : "2022-12-15", "use_time" : 3.56 } ] }, { "desktop_id" : "d5367f84-1d64-498e-9b92-093002ac6ce9", "used_info_list" : [ { "date" : "2022-12-09", "use_time" : 10.56 }, { "date" : "2022-12-10", "use_time" : 1.38 }, { "date" : "2022-12-11", "use_time" : 0 }, { "date" : "2022-12-12", "use_time" : 0 }, { "date" : "2022-12-13", "use_time" : 0 }, { "date" : "2022-12-14", "use_time" : 3.87 }, { "date" : "2022-12-15", "use_time" : 3.56 } ] } ], "total_count" : 2 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 否 Array of strings 桌面id集合。 start_time 否 String 开始时间,格式:yyyy-MM-dd(UTC时间,不传查默认最近15天)最多查31天数据。 end_time 否 String 结束时间,格式:yyyy-MM-dd(UTC时间,不传查默认最近15天)最多查31天数据。 group_by_type 否 String 统计方式,不传则默认按天。可选值为: DAY: 按天。 HOUR: 按小时。 desktop_username 否 String 若传桌面的用户名,则查询使用时间只有该用户的使用时间。 offset 否 Integer 从查询结果中的第几条数据开始返回,用于分页查询,取值范围0-2147483647,默认从0开始。 limit 否 Integer 查询结果中想要返回的信息条目数量,用于分页查询,取值范围0-100,默认值100。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 otp_config_info OtpConfigInfo object OTP辅助认证方式配置 表4 OtpConfigInfo 参数 参数类型 描述 enable Boolean 是否启用 receive_mode String 验证码接收模式 VMFA:虚拟MFA设备 HMFA:硬件MFA设备 auth_url String 辅助认证服务器地址 app_id String 认证服务接入账号 app_secret String 认证服务接入密码 auth_server_access_mode String 辅助认证服务接入模式 INTERNET:互联网接入 DEDICATED:专线接入 SYSTEM_DEFAULT:系统默认 cert_content String pem格式证书内容 apply_rule ApplyRuleInfo object 认证应用对象信息,为null时代表对所有应用对象生效。 表5 ApplyRuleInfo 参数 参数类型 描述 rule_type String 认证应用对象类型。 AC CES S_MODE:接入类型 rule String 认证应用对象。 INTERNET:互联网接入,rule_type为ACCESS_MODE时可选该值 PRIVATE:专线接入,rule_type为ACCESS_MODE时可选该值 状态码: 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接口进行解密。