功能介绍
查询协同桌面默认用户配置(当前功能公测中,需要使用请联系管理员申请使用)。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
| workspace:tenants:getShareSpaceConfig | Read | - | - | - | - |
URI
GET /v2/{project_id}/share-space/configuration
表1 路径参数 | 参数 | 是否必选 | 参数类型 | 描述 |
| project_id | 是 | String | 项目ID。 |
表2 Query参数 | 参数 | 是否必选 | 参数类型 | 描述 |
| name | 是 | String | 查询协同桌面默认用户配置, share-space-user-conf。 |
响应参数
状态码:200
表3 响应Body参数 | 参数 | 参数类型 | 描述 |
| config_name | String | 配置名称。 |
| config_value | String | 配置值,使用Json字符串,'{"share_space_name":“协同空间”, "use_share_password":是否使用协同密码:true/false, "allow_anonymous":是否匿名加入协同:true/false, "audio_and_video":是否使用音频,"AUDIO"/"NONE"/"AUDIO_AND_VIDEO","keyboard_mouse_ctl":云桌面是否可用键鼠true/false,"anonymous_input_ctrl":是否开启匿名用户键鼠输入权限true/false, "is_user_confirm_enabled":是否需要用户应答true/false,"wait_confirm_time":等待时间30-180s}。' |
状态码:400
表4 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| error_detail | String | 错误详情。 |
| encoded_authorization_message | String | 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:401
表5 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| error_detail | String | 错误详情。 |
| encoded_authorization_message | String | 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:403
表6 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| error_detail | String | 错误详情。 |
| encoded_authorization_message | String | 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:404
表7 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| error_detail | String | 错误详情。 |
| encoded_authorization_message | String | 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:500
表8 响应Body参数 | 参数 | 参数类型 | 描述 |
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| error_detail | String | 错误详情。 |
| encoded_authorization_message | String | 加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
响应示例
状态码:200
正常。
{
"config_name" : "share-space-user-conf",
"config_value" : "'{\"share_space_name\":\"协同空间\", \"use_share_password\":true, \"allow_anonymous\":true, \"audio_and_video\":\"AUDIO\",\"keyboard_mouse_ctl\":false, \"anonymous_input_ctrl\":false, \"is_user_confirm_enabled\":false,\"wait_confirm_time\":30}'"
} 状态码
| 状态码 | 描述 |
| 200 | 正常。 |
| 400 | 由于包含语法错误,当前请求无法被服务器理解。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 404 | 找不到资源。 |
| 500 | 服务内部错误,具体返回错误码请参见错误码说明。 |