查询已触发的事件通知记录
功能介绍
查询三个月内所有已触发的事件通知记录。
接口约束
仅保存三个月以内的事件通知记录。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/csms/notification-records
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
event_name |
String |
凭据名称。 |
trigger_event_type |
String |
凭据类型 取值 : COMMON :通用凭据 RDS :RDS凭据 |
create_time |
Long |
事件通知记录的创建时间,时间戳,即从1970年1月1日至该时间的总秒数。 |
secret_name |
String |
凭据名称。 |
secret_type |
String |
凭据类型 取值 : COMMON :通用凭据(默认)。用于应用系统中的各种敏感信息储存。 RDS :RDS凭据 。专门针对RDS的凭据,用于存储RDS的账号信息。 |
notification_target_name |
String |
事件通知的对象名称。 |
notification_target_id |
String |
事件通知的对象ID。 |
notification_content |
String |
凭据的描述信息。 |
notification_status |
String |
凭据类型 取值 : SUCCESS :事件通知成功。 FAIL :事件通知失败。 INVALID :事件通知配置主题信息无效或不正确,无法触发通知。 |
参数 |
参数类型 |
描述 |
---|---|---|
next_marker |
String |
下一页查询地址(本页的末尾凭据名称,下一页起始凭据名称)。 |
previous_marker |
String |
本页的起始凭据名称,上一页末尾凭据名称。 |
current_count |
Integer |
本页返回条目数量。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorDetail object |
错误信息返回体。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorDetail object |
错误信息返回体。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorDetail object |
错误信息返回体。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorDetail object |
错误信息返回体。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorDetail object |
错误信息返回体。 |
状态码: 502
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorDetail object |
错误信息返回体。 |
状态码: 504
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrorDetail object |
错误信息返回体。 |
请求示例
无
响应示例
状态码: 200
请求已成功
{ "records" : [ { "event_name" : "demo-event", "trigger_event_type" : "SECRET_VERSION_EXPIRED", "create_time" : 1581507580000, "secret_name" : "demo-secret", "secret_type" : "COMMON", "notification_target_name" : "SecertExpirationNotificationTest", "notification_target_id" : "urn:smn:cn-north-4:SecertExpirationTest", "notification_content" : "{\"eventName\":\"TestEvent20221112\",\"eventType\":\"SECRET_VERSION_EXPIRED\",\"eventTime\":\"2023-04-14T20:25:10.126Z\",\"data\":{\"secretId\":\"fde3d6ba-cb31-40b0-b6c4-78757050f8c8\",\"secretName\":\"Secret20230325\",\"createTime\":\"2023-03-22T20:43:04.000Z\",\"updateTime\":\"2023-04-14T20:18:29.000Z\",\"versionId\":\"v18\",\"versionExpireTime\":\"2023-03-29T17:07:23.000Z\"}}", "notification_status" : "SUCCESS" } ] }
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 |
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.csms.v1.region.CsmsRegion; import com.huaweicloud.sdk.csms.v1.*; import com.huaweicloud.sdk.csms.v1.model.*; public class ListNotificationRecordsSolution { 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); CsmsClient client = CsmsClient.newBuilder() .withCredential(auth) .withRegion(CsmsRegion.valueOf("<YOUR REGION>")) .build(); ListNotificationRecordsRequest request = new ListNotificationRecordsRequest(); try { ListNotificationRecordsResponse response = client.listNotificationRecords(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 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcsms.v1.region.csms_region import CsmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcsms.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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CsmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(CsmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListNotificationRecordsRequest() response = client.list_notification_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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" csms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/csms/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/csms/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/csms/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 := csms.NewCsmsClient( csms.CsmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListNotificationRecordsRequest{} response, err := client.ListNotificationRecords(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
400 |
请求参数有误 |
401 |
被请求的页面需要用户名和密码 |
403 |
认证失败 |
404 |
资源不存在,资源未找到 |
500 |
服务内部错误 |
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
504 |
网关超时 |
错误码
请参见错误码。