更新时间:2024-02-29 GMT+08:00
分享

创建事件

功能介绍

创建事件,事件可配置在一个或多个凭据对象上。当事件为启用状态且包含的基础事件类型在凭据对象上触发时,云服务会将对应的事件通知发送至事件指定的通知主题上。

接口约束

创建的事件通知无法单独使用,需要配置在具体的凭据对象上。服务不会对事件通知中的通知对象进行有效性检查,如果用户账号下不存在该通知对象,则会造成事件触发时,事件通知失败。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/csms/events

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

新创建事件通知的名称。

约束:取值范围为1到64个字符,满足正则匹配“^[a-zA-Z0-9_-]{1,64}$”。

event_types

Array of strings

本次事件通知的基础事件列表,基础事件类型如下。

SECRET_VERSION_CREATED:版本创建 SECRET_VERSION_EXPIRED:版本过期 SECRET_ROTATED:凭据轮转 SECRET_DELETED:凭据删除

列表包含的基础事件类型不能重复。

state

String

控制事件是否生效,只有启用状态才能触发包含的基础事件类型

ENABLED:启用 DISABLED:禁用

notification

Notification object

通知主题对象。

表4 Notification

参数

是否必选

参数类型

描述

target_type

String

事件通知的对象类型。

target_id

String

事件通知的对象ID。

target_name

String

事件通知的对象名称。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

event

Event object

事件通知对象。

表6 Event

参数

参数类型

描述

name

String

事件通知名称。

event_id

String

事件通知的资源标识符。

event_types

Array of strings

设置事件的基础事件类型列表,。

约束:数组大小:最小1,最大12。

state

String

事件通知状态,取值如下。

ENABLED:表示启用状态 DISABLED:表示禁用状态

create_time

Long

事件通知创建时间,时间戳,即从1970年1月1日至该时间的总秒数。

update_time

Long

事件通知上次更新时间,时间戳,即从1970年1月1日至该时间的总秒数。

notification

Notification object

通知主题对象。

表7 Notification

参数

参数类型

描述

target_type

String

事件通知的对象类型。

target_id

String

事件通知的对象ID。

target_name

String

事件通知的对象名称。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表9 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 401

表10 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表11 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 403

表12 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表13 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 404

表14 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表15 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 500

表16 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表17 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 502

表18 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表19 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码: 504

表20 响应Body参数

参数

参数类型

描述

error

ErrorDetail object

错误信息返回体。

表21 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

请求示例

创建事件。

{
  "name" : "demo-event",
  "event_types" : [ "SECRET_VERSION_CREATED", "SECRET_VERSION_EXPIRED" ],
  "state" : "ENABLED",
  "notification" : {
    "target_type" : "SMN",
    "target_id" : "urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:test-poc",
    "target_name" : "demo-smn-name"
  }
}

响应示例

状态码: 200

请求已成功

{
  "event" : {
    "name" : "event-test",
    "event_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "state" : "ENABLED",
    "event_types" : [ "SECRET_VERSION_CREATED", "SECRET_VERSION_EXPIRED" ],
    "create_time" : 1581507580000,
    "update_time" : 1581507580000,
    "notification" : {
      "target_type" : "SMN",
      "target_id" : "urn:smn:cn-north-4:SecertExpirationTest",
      "target_name" : "SecertExpirationNotificationTest"
    }
  }
}

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
51
52
53
54
55
56
57
58
59
60
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateSecretEventSolution {

    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();
        CreateSecretEventRequest request = new CreateSecretEventRequest();
        CreateSecretEventRequestBody body = new CreateSecretEventRequestBody();
        Notification notificationbody = new Notification();
        notificationbody.withTargetType("SMN")
            .withTargetId("urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:test-poc")
            .withTargetName("demo-smn-name");
        List<String> listbodyEventTypes = new ArrayList<>();
        listbodyEventTypes.add("SECRET_VERSION_CREATED");
        listbodyEventTypes.add("SECRET_VERSION_EXPIRED");
        body.withNotification(notificationbody);
        body.withState(CreateSecretEventRequestBody.StateEnum.fromValue("ENABLED"));
        body.withEventTypes(listbodyEventTypes);
        body.withName("demo-event");
        request.withBody(body);
        try {
            CreateSecretEventResponse response = client.createSecretEvent(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
36
37
38
39
40
41
42
43
44
# 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 = CreateSecretEventRequest()
        notificationbody = Notification(
            target_type="SMN",
            target_id="urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:test-poc",
            target_name="demo-smn-name"
        )
        listEventTypesbody = [
            "SECRET_VERSION_CREATED",
            "SECRET_VERSION_EXPIRED"
        ]
        request.body = CreateSecretEventRequestBody(
            notification=notificationbody,
            state="ENABLED",
            event_types=listEventTypesbody,
            name="demo-event"
        )
        response = client.create_secret_event(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
50
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.CreateSecretEventRequest{}
	notificationbody := &model.Notification{
		TargetType: "SMN",
		TargetId: "urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:test-poc",
		TargetName: "demo-smn-name",
	}
	var listEventTypesbody = []string{
        "SECRET_VERSION_CREATED",
	    "SECRET_VERSION_EXPIRED",
    }
	request.Body = &model.CreateSecretEventRequestBody{
		Notification: notificationbody,
		State: model.GetCreateSecretEventRequestBodyStateEnum().ENABLED,
		EventTypes: listEventTypesbody,
		Name: "demo-event",
	}
	response, err := client.CreateSecretEvent(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

网关超时

错误码

请参见错误码

分享:

    相关文档

    相关产品