huawei-cloud-api-definitions-CSMS 0.1.20250523

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"Error":{"properties":{"error":{"$ref":"#/definitions/ErrorDetail","description":"错误信息返回体。"}},"type":"object"},"ErrorDetail":{"properties":{"error_code":{"description":"错误请求返回的错误码","maxLength":36,"minLength":3,"type":"string"},"error_msg":{"description":"错误请求返回的错误信息","maxLength":1024,"minLength":0,"type":"string"}}},"Event":{"description":"事件通知对象。","properties":{"create_time":{"description":"事件通知创建时间,时间戳,即从1970年1月1日至该时间的总秒数。","example":1581507580000,"format":"int64","maximum":13,"minimum":0,"type":"integer"},"event_id":{"description":"事件通知的资源标识符。","example":"2d1152f2-290d-4756-a1d2-e12c14992416","pattern":"^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$","type":"string"},"event_types":{"description":"设置事件的基础事件类型列表,。\n\n约束:数组大小:最小1,最大12。","example":"eventDemo","items":{"description":"本次事件通知的基础事件列表,基础事件类型如下。\n\nSECRET_VERSION_CREATED:版本创建\nSECRET_VERSION_EXPIRED:版本过期\nSECRET_ROTATED:凭据轮转\nSECRET_DELETED:凭据删除\n\n列表包含的基础事件类型不能重复。","enum":["SECRET_VERSION_CREATED","SECRET_VERSION_EXPIRED","SECRET_ROTATED","SECRET_DELETED","SECRET_ROTATED_FAILED"],"type":"string"},"maxItems":12,"minItems":1,"type":"array"},"name":{"description":"事件通知名称。","example":"demo","pattern":"^[a-zA-Z0-9_-]{1,64}$","type":"string"},"notification":{"$ref":"#/definitions/Notification"},"state":{"description":"事件通知状态,取值如下。\n\nENABLED:表示启用状态\nDISABLED:表示禁用状态","enum":["ENABLED","DISABLED"],"example":"ENABLED","maxLength":1,"minLength":1,"type":"string"},"update_time":{"description":"事件通知上次更新时间,时间戳,即从1970年1月1日至该时间的总秒数。","example":1581507580000,"format":"int64","maximum":13,"minimum":0,"type":"integer"}},"type":"object"},"ListEventResponseBody":{"properties":{"events":{"description":"事件详情列表。","items":{"$ref":"#/definitions/Event"},"maxItems":1000,"minItems":0,"type":"array"},"page_info":{"$ref":"#/definitions/PageInfo"}},"type":"object"},"Notification":{"description":"通知主题对象。","properties":{"target_id":{"description":"事件通知的对象ID。","example":"urn:smn:cn-north-4:dc3b7c85759141accc0f2068:test-poc","pattern":"^[a-zA-Z0-9\\-._:]{1,256}$","type":"string"},"target_name":{"description":"事件通知的对象名称。","example":"test-poc","pattern":"^[a-zA-Z0-9_-]{1,64}$","type":"string"},"target_type":{"description":"事件通知的对象类型。","example":"SMN","pattern":"^SMN$","type":"string"}},"required":["target_type","target_id","target_name"],"type":"object"},"PageInfo":{"description":"分页信息。","properties":{"current_count":{"description":"本页返回条目数量。","example":1000,"format":"int32","maximum":1000,"minimum":0,"type":"integer"},"next_marker":{"description":"下一页查询地址(本页的末尾凭据名称,下一页起始凭据名称)。","example":"secret-name-test","pattern":"^[a-zA-Z0-9_-]{1,64}$","type":"string"},"previous_marker":{"description":"本页的起始凭据名称,上一页末尾凭据名称。","example":"secret-name-test","pattern":"^[a-zA-Z0-9_-]{1,64}$","type":"string"}}}},"description":null,"group_id":"2696b19762094c0393f47c92da7528c5","host":"kms.cn-north-4.myhuaweicloud.com","id":"1c348f90528f4252bb773bdaf4d356b1","info_version":"v1","method":"get","name":"ListSecretEvents","parameters":{},"paths":{"/v1/{project_id}/csms/events":{"get":{"description":"查询当前用户在本项目下创建的所有事件。","operationId":"ListSecretEvents","parameters":[{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2097152,"minLength":32,"name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX..."},{"description":"项目ID。","in":"path","maxLength":64,"minLength":32,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"每页返回的个数。\n\n默认值:50。","in":"query","maxLength":4,"minLength":1,"name":"limit","required":false,"type":"string","x-example":"50"},{"description":"分页查询起始的事件名称,为空时为查询第一页","in":"query","name":"marker","pattern":"^[a-zA-Z0-9._-]{1,64}$","required":false,"type":"string","x-example":"test_123"}],"produces":["application/json"],"responses":{"200":{"description":"请求已成功","examples":{"application/json":{"events":[{"create_time":1669042498000,"event_id":"120eeafd-eca5-4098-8733-c1b369f3a450","event_types":["SECRET_VERSION_CREATED","SECRET_VERSION_EXPIRED","SECRET_VERSION_NEAR_EXPIRY","SECRET_DELETED"],"name":"TestEvent1","notification":{"target_id":"urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:smn-target-name","target_name":"smn-target-name","target_type":"SMN"},"state":"ENABLED","update_time":1669042498000},{"create_time":1669041491000,"event_id":"1d251c99-37d2-4396-86ce-f000d3aa9850","event_types":["SECRET_VERSION_CREATED","SECRET_VERSION_EXPIRED","SECRET_VERSION_NEAR_EXPIRY","SECRET_DELETED"],"name":"TestEvent2","notification":{"target_id":"urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:smn-target-name","target_name":"smn-target-name","target_type":"SMN"},"state":"ENABLED","update_time":1669041491000}],"page_info":{"current_count":2,"next_marker":"TestEvent2","previous_marker":"TestEvent3"}}},"schema":{"$ref":"#/definitions/ListEventResponseBody"}},"400":{"description":"请求参数有误","schema":{"$ref":"#/definitions/Error"}},"401":{"description":"被请求的页面需要用户名和密码","schema":{"$ref":"#/definitions/Error"}},"403":{"description":"认证失败","schema":{"$ref":"#/definitions/Error"}},"404":{"description":"资源不存在,资源未找到","schema":{"$ref":"#/definitions/Error"}},"500":{"description":"服务内部错误","schema":{"$ref":"#/definitions/Error"}},"502":{"description":"请求未完成。服务器从上游服务器收到一个无效的响应","schema":{"$ref":"#/definitions/Error"}},"504":{"description":"网关超时","schema":{"$ref":"#/definitions/Error"}}},"summary":"查询事件列表","tags":["事件管理"],"x-constraint":"此接口返回的信息为事件通知的元数据信息,不包含凭据值。","x-is-registered":"Y","x-support-sdk":"Y"}}},"product_short":"CSMS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询事件列表","tags":"事件管理","uri":null,"version":"2.0"}