huawei-cloud-api-definitions-BCC 0.1.20251025

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"ErrorRsp":{"description":"失败时返回的错误对象","properties":{"error_code":{"description":"错误码","maxLength":36,"minLength":8,"type":"string"},"error_msg":{"description":"错误描述","maxLength":512,"minLength":2,"type":"string"}},"required":["error_code","error_msg"]},"EventDetailEntity":{"description":"事件详情实体类","properties":{"content":{"description":"事件内容","type":"string"},"dimensions":{"description":"事件维度","type":"string"},"event_level":{"$ref":"#/definitions/EventLevelEnum"},"event_state":{"$ref":"#/definitions/EventStateEnum"},"event_type":{"description":"事件类型","type":"string"},"event_user":{"description":"事件用户","type":"string"},"group_id":{"description":"组ID","type":"string"},"resource_id":{"description":"资源ID","type":"string"},"resource_name":{"description":"资源名","type":"string"}},"type":"object"},"EventEntity":{"description":"事件实体类","properties":{"detail":{"$ref":"#/definitions/EventDetailEntity","description":"事件详情"},"event_id":{"description":"事件ID","type":"string"},"event_name":{"description":"事件名称","type":"string"},"event_source":{"$ref":"#/definitions/EventSourceEnum"},"event_type":{"description":"事件类型","type":"string"},"time":{"description":"事件产生时间","type":"string"}},"required":["event_id"],"type":"object"},"EventLevelEnum":{"description":"事件级别,取值范围:Critical,Major,Minor,Info","enum":["Critical","Major","Minor","Info"],"example":"Critical","type":"string"},"EventSourceEnum":{"description":"事件来源,取值范围:SYS.CBR,SYS.RDS,SYS.GaussDB","enum":["SYS.CBR","SYS.RDS","SYS.GaussDB"],"example":"SYS.CBR","type":"string"},"EventStateEnum":{"description":"事件状态,取值范围:normal,warning,incident","enum":["normal","warning","incident"],"example":"normal","type":"string"},"ListEventsResponseBody":{"description":"查询告警列表","properties":{"count":{"description":"本次分页查询响应的事件条数","exclusiveMaximum":true,"format":"int64","maximum":65535,"minimum":0,"type":"integer"},"events":{"description":"事件","items":{"$ref":"#/definitions/EventEntity"},"maxItems":100,"minItems":0,"type":"array"},"next_marker":{"description":"下一页的marker","maxLength":38,"type":"string"}},"required":["count","events"],"type":"object"}},"description":null,"group_id":"0cb6191c2c524d62be604224b207d979","host":"bcc.cn-north-4.myhuaweicloud.com","id":"0e194d3eeccf4ce09d2db7e09dc2d17c","info_version":"v1","method":"get","name":"ListEvents","parameters":{},"paths":{"/v1/{domain_id}/events":{"get":{"description":"查询事件数据","operationId":"ListEvents","parameters":[{"description":"账号ID","in":"path","maxLength":32,"minLength":16,"name":"domain_id","pattern":"^[a-z0-9]{16,32}$","required":true,"type":"string"},{"description":"区域ID","in":"query","maxLength":32,"minLength":6,"name":"region_id","pattern":"^[a-z0-9-]{6,32}$","required":false,"type":"string"},{"description":"事件源,取值范围:SYS.CBR,SYS.RDS,SYS.GaussDB","enum":["SYS.CBR","SYS.RDS","SYS.GaussDB"],"in":"query","maxLength":16,"minLength":2,"name":"event_source","required":false,"type":"string"},{"description":"事件等级,取值范围:Critical,Major,Minor,Info","enum":["Critical","Major","Minor","Info"],"in":"query","maxLength":16,"minLength":2,"name":"event_level","required":false,"type":"string"},{"description":"事件名称,长度范围4-64个字符。","in":"query","maxLength":64,"minLength":4,"name":"event_name","pattern":"^[a-zA-Z][a-zA-Z0-9_]{3,63}$","required":false,"type":"string"},{"description":"资源ID,长度范围16-64个字符。","in":"query","maxLength":64,"minLength":16,"name":"resource_id","pattern":"^[0-9a-zA-Z-]{16,64}$","required":false,"type":"string"},{"description":"查询范围起始时间,例如:2025-03-20T09:31:45Z。","in":"query","maxLength":24,"minLength":20,"name":"start_time","pattern":"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\\.\\d{1,3})?Z$","required":false,"type":"string"},{"description":"查询范围结束时间,例如:2025-03-20T09:31:45Z。","in":"query","maxLength":24,"minLength":20,"name":"end_time","pattern":"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\\.\\d{1,3})?Z$","required":false,"type":"string"},{"description":"分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页。","in":"query","maxLength":38,"minLength":38,"name":"marker","required":false,"type":"string"},{"default":10,"description":"单次查询的条数限制,取值范围(0,100],默认值为10,用于限制结果数据条数。","format":"int32","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"操作成功。","examples":{"application/json":{"count":49,"events":[{"detail":{"content":"{\"request_id\": \"req-09921ee57b244e52e370a588f27c8e28\", \"vault_id\": \"f943ef69-1071-4a46-9c45-962c7f826da5\", \"vault_spec_code\": \"vault.backup.server.normal\", \"vault_status\": \"available\", \"vault_used\": 65864, \"vault_size\": 160}","dimensions":"[]","event_level":"Minor","event_state":"normal","event_type":"EVENT.SYS","event_user":"6fdb9474162e4661bc39e41a718cf3f9","group_id":"","resource_id":"f943ef69-1071-4a46-9c45-962c7f826da5","resource_name":"vault-bcc-01"},"event_id":"ev1746664615957eyzRmoyL0","event_name":"backupDeletionSucceeded","event_source":"SYS.CBR","event_type":"EVENT.SYS","time":"2025-05-08T00:36:55Z"}]}},"schema":{"$ref":"#/definitions/ListEventsResponseBody"}},"400":{"description":"请求错误。","schema":{"$ref":"#/definitions/ErrorRsp"}},"401":{"description":"未提供认证信息或认证信息错误。","schema":{"$ref":"#/definitions/ErrorRsp"}},"403":{"description":"请求页面被禁止访问。","schema":{"$ref":"#/definitions/ErrorRsp"}},"404":{"description":"未找到资源。","schema":{"$ref":"#/definitions/ErrorRsp"}},"408":{"description":"请求超出了服务器的等待时间。","schema":{"$ref":"#/definitions/ErrorRsp"}},"429":{"description":"当前请求过多。","schema":{"$ref":"#/definitions/ErrorRsp"}},"500":{"description":"请求未完成,服务异常。","schema":{"$ref":"#/definitions/ErrorRsp"}},"503":{"description":"系统暂时不可用,请求受限。","schema":{"$ref":"#/definitions/ErrorRsp"}}},"summary":"查询事件数据","tags":["监控"],"x-api-type":"open-api","x-iam-auth-meta-anno":{"abacAction":"bcc::listEvent","authContextInitializerName":"baseIamAuthContextInitializer","authLevel":"NO_INSTANCE","model":"v5","needAbacCheck":true,"needAbacResourceCheck":false,"needApigwJwtAuthCheck":false,"needCbcCheck":false,"needRbacCheck":false,"needResourceTagCheck":false,"supportAllGrantedEps":false},"x-is-registered":"Y","x-request-examples-1":"https://{endpoint}/v1/{domain_id}/events?region_id=&event_name=&event_source=&event_level=&resource_id=&from=&to=&limit=1","x-request-examples-text-1":"https://{endpoint}/v1/{domain_id}/events?region_id=&event_name=&event_source=&event_level=&resource_id=&from=&to=&limit=1","x-request-examples-url-1":"GET https://{endpoint}/v1/{domain_id}/events","x-support-sdk":"Y"}}},"product_short":"BCC","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询事件数据","tags":"监控","uri":null,"version":"2.0"}