查询openAPI所有回调记录 - ListOpenApiCalledRecord
功能介绍
功能介绍:查询openApi所有回调记录
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/openapi/called-records
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页大小。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1000 |
| called_url | 否 | String | 参数解释: 调用URL。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 空字符串 |
| start_time | 否 | Long | 参数解释: 开始时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
| end_time | 否 | Long | 参数解释: 结束时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 9223372036854775807 |
| marker | 否 | String | 参数解释: 分页标记。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 空字符串 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| succeed | Integer | 参数解释: 成功数 取值范围: 不涉及 |
| failed | Integer | 参数解释: 失败数 取值范围: 不涉及 |
| openapi_called_records | Array of OpenApiCalledRecord objects | 参数解释: openAPI调用记录 取值范围: 不涉及 |
| next_marker | String | 参数解释: 下一页查询标记 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| user_name | String | 参数解释: 用户名 取值范围: 不涉及 |
| user_id | String | 参数解释: 用户ID,唯一标识 取值范围: 不涉及 |
| domain_name | String | 参数解释: 账号名 取值范围: 不涉及 |
| domain_id | String | 参数解释: 账号ID 取值范围: 不涉及 |
| request_url | String | 参数解释: 请求URL 取值范围: 不涉及 |
| request_method | String | 参数解释: 请求方法 取值范围: 不涉及 |
| response_code | String | 参数解释: 响应码 取值范围: 不涉及 |
| fail_reason | String | 参数解释: 失败原因 取值范围: 不涉及 |
| timestamp | Long | 参数解释: 时间戳 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
{
"total" : 88,
"succeed" : 85,
"failed" : 3,
"openapi_called_records" : [ {
"user_name" : "security-admin",
"user_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
"domain_name" : "tenant-domain-01",
"domain_id" : "a7b8c9d0-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"request_url" : "/v1/2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d/sdg/watermark/embed",
"request_method" : "POST",
"response_code" : "200",
"fail_reason" : "鉴权失败",
"timestamp" : 1700000000000
} ],
"next_marker" : "marker-cursor-9f2a3b4c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。