查询热点会话不迁移用户 - ListNonMigrationUsers
功能介绍
查询热点会话不迁移用户。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/hotspot-session-config/{config_id}/non-migration-users
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。 |
| config_id | 是 | String | 热点会话迁移配置ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| user_name | 否 | String | 用户名。 |
| offset | 否 | Integer | 查询的偏移量。 |
| limit | 否 | Integer | 查询的数量,值区间[1-100]。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 热点时不迁移用户id总数量。 |
| non_migrate_users | Array of UserInfo objects | 热点时不迁移用户id列表。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:405
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:503
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
请求示例
GET /v1/a4da8115c9d8464ead3a38309130523f/hotspot-session/d2a3rd115c9ea2b32123sa45hbcf12/non-migration-users null
响应示例
状态码:200
查询热点会话不迁移用户的响应。
{
"non_migrate_users" : [ {
"user_id" : "da16f9b8bc9444029cc171a4f7286353",
"user_name" : "test"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询热点会话不迁移用户的响应。 |
| 400 | 由于包含语法错误,当前请求无法被服务器理解。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 404 | 找不到资源。 |
| 405 | 请求中指定的方法不被允许。 |
| 500 | 服务内部错误,具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。 |
错误码
请参见错误码。