查询OpenApi调用记录
功能介绍
查询OpenApi调用记录
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/openapi/called-records
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
分页大小,默认1000,最大2000。 |
called_url |
否 |
String |
需要查询调用记录的URL,例如:/v1/{project_id}/sdg/database/watermark/embed |
start_time |
否 |
Long |
开始时间(Unix timestamp),单位:毫秒,例如:0 |
end_time |
否 |
Long |
结束时间(Unix timestamp),单位:毫秒,例如:1638515803572 |
marker |
否 |
String |
指定一个标识符。获取第一页时不用赋值,获取下一页时取上页查询结果的返回值。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
调用API总次数 |
succeed |
Integer |
调用API成功次数 |
failed |
Integer |
调用API失败次数 |
openapi_called_records |
Array of OpenApiCalledRecord objects |
API调用记录列表 |
next_marker |
String |
获取下一页所需的标识符。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_name |
String |
调用API的user_name |
user_id |
String |
调用API的user_id |
domain_name |
String |
调用API的domain_name |
domain_id |
String |
调用API的domain_id |
request_url |
String |
调用API的URL |
request_method |
String |
http请求方法 |
response_code |
String |
http状态码 |
fail_reason |
String |
调用API失败原因 |
timestamp |
Long |
调用API的时间(Unix timestamp),单位:毫秒 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
查询OpenAPI调用记录
GET /v1/{project_id}/openapi/called-records
响应示例
状态码: 200
OK
{ "total" : 11, "succeed" : 11, "failed" : 0, "openapi_called_records" : [ { "user_name" : "xxxxxxxxxxxxx", "user_id" : "xxxxxxxxxxxxxxxxx", "domain_name" : "xxxxxxxxxxxxxxxxx", "domain_id" : "xxxxxxxxxxxxxxxxxxx", "request_url" : "/v1/xxxxxxxxxxxxxxxxxxxxxxxxxxx/sdg/doc/watermark/embed", "request_method" : "POST", "response_code" : "200", "fail_reason" : "", "timestamp" : 1638427576524 } ], "next_marker" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }
状态码: 400
无效请求
{ "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }
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 48 49 50 |
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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); ShowOpenApiCalledRecordsRequest request = new ShowOpenApiCalledRecordsRequest(); request.withLimit(<limit>); request.withCalledUrl("<called_url>"); request.withStartTime(<start_time>L); request.withEndTime(<end_time>L); request.withMarker("<marker>"); 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 32 33 34 35 |
# 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"] credentials = BasicCredentials(ak, sk) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowOpenApiCalledRecordsRequest() request.limit = <limit> request.called_url = "<called_url>" request.start_time = <start_time> request.end_time = <end_time> request.marker = "<marker>" 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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dsc.NewDscClient( dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowOpenApiCalledRecordsRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest calledUrlRequest:= "<called_url>" request.CalledUrl = &calledUrlRequest startTimeRequest:= int64(<start_time>) request.StartTime = &startTimeRequest endTimeRequest:= int64(<end_time>) request.EndTime = &endTimeRequest markerRequest:= "<marker>" request.Marker = &markerRequest response, err := client.ShowOpenApiCalledRecords(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
无效请求 |
错误码
请参见错误码。