查询openAPI所有回调记录 - ShowOpenApiCalledRecords
功能介绍
功能介绍:查询openApi所有回调记录
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/openapi/called-records
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为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的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码: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 | 参数解释: 时间戳,为13位毫秒级Unix时间戳,表示回调记录的触发时间点 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
{
"total" : 1,
"succeed" : 1,
"failed" : 0,
"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"
} SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dsc.v1.region.DscRegion; import com.huaweicloud.sdk.dsc.v1.*; import com.huaweicloud.sdk.dsc.v1.model.*; public class ShowOpenApiCalledRecordsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); ShowOpenApiCalledRecordsRequest request = new ShowOpenApiCalledRecordsRequest(); try { ShowOpenApiCalledRecordsResponse response = client.showOpenApiCalledRecords(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdsc.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowOpenApiCalledRecordsRequest() response = client.show_open_api_called_records(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dsc.NewDscClient(hcClient) request := &model.ShowOpenApiCalledRecordsRequest{} response, err := client.ShowOpenApiCalledRecords(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。