接口介绍
获取角色列表
接口约束
支持的线上资源池 ：合肥2、西安5
URI
GET /v4/oss/list-roles
请求参数
请求 Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| keyword | 否 | String | 模糊查询角色名，不区分大小写 | ro |
| pageSize | 否 | Integer | 单页数量，取值范围 1~50，默认值为10 | 6 |
| page | 否 | Integer | 页码，若与参数 pageNo 同时存在，以 pageNo 为准，默认值为1 | 2 |
| pageNo | 否 | Integer | 页码，默认值为1 | 2 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：800 成功 |
800 |
| message | String | 状态描述 | SUCCESS |
| returnObj | Object | 响应对象 | 见下级对象 |
| description | String | 状态描述，一般为中文 | 成功 |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| totalCount | Integer | 总数 | 20 |
| currentCount | Integer | 当前页记录数 | 20 |
| status | Bool | 角色状态 | ture |
| fuser_last_updated | String | 最近更新时间 | 2023-03-31T06:42:44Z |
| role_arn | String | 角色arn | arn:aws:iam:::role/role-zs1 |
| policy_name | Array of Objects | 该角色下绑定的策略列表 | 见下级对象 |
| note | String | 角色备注 | role_note1 |
| role_name | String | 角色名 | role1 |
| created_time | String | 角色创建时间 | 2023-05-08T08:46:28Z |
表 policy_name
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| note | String | 策略备注 | policy_note1 |
| bind_date | String | 策略绑定时间 | 2023-05-09T01:29:43Z |
| policy_name | String | 策略名 | policy1 |
请求示例
{
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"pageSize": 4,
"page":2,
"pageNo":2,
"keyword": "role"
}
响应示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800,
"returnObj": {
"totalCount": 4,
"currentCount": 2,
"result": [
{
"status": true,
"fuser_last_updated": "2023-05-09T01:29:43Z",
"role_arn": "arn:aws:iam:::role/role-xxx",
"policy_name": [
{
"note": "",
"bind_date": "2023-05-09T01:29:43Z",
"policy_name": "policy1"
}
],
"note": "",
"role_name": "role1",
"created_time": "2023-05-08T08:46:28Z"
},
{
"status": true,
"fuser_last_updated": "2023-05-15T09:29:46Z",
"role_arn": "arn:aws:iam:::role/role-xxx",
"policy_name": [],
"note": "",
"role_name": "role2",
"created_time": "2023-05-15T09:29:46Z"
},
{
"status": true,
"fuser_last_updated": "2023-05-10T08:22:26Z",
"role_arn": "arn:aws:iam:::role/role-xxx",
"policy_name": [],
"note": "",
"role_name": "role3",
"created_time": "2023-05-10T08:22:26Z"
},
{
"status": true,
"fuser_last_updated": "2023-05-11T09:14:53Z",
"role_arn": "arn:aws:iam:::role/role-xxx",
"policy_name": [],
"note": "",
"role_name": "role4",
"created_time": "2023-05-11T09:14:53Z"
}
]
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 表示请求失败。 |
错误码
errorCode 枚举值，见错误码总表
