华为云用户手册

请求示例 /v2/{project_id}/dbss/audit/charge/period/order{ "flavor_ref" : "st6.xlarge.4", "name" : "DBSS-acc3", "vpc_id" : "4c035747-f77b-4c6d-b23b-cb3a2b96c7e6", "availability_zone" : "xx-xx", "comment" : "", "region" : "xx-xx", "nics" : [ { "subnet_id" : "6201dcf2-1374-43ec-ae8b-78b4081572d3" } ], "security_groups" : [ { "id" : "04088976-9c63-4e6b-9070-84e6a30c782b" } ], "cloud_service_type" : "hws.service.type.dbss", "charging_mode" : 0, "period_type" : 2, "period_num" : 1, "subscription_num" : 1, "is_auto_renew" : 0, "product_infos" : [ { "product_id" : "00301-xxxxxxx-0--0", "cloud_service_type" : "hws.service.type.dbss", "resource_type" : "hws.resource.type.dbss", "resource_spec_code" : "dbss.bypassaudit.low", "product_spec_desc" : "{\"specDesc\":{\"zh-cn\":{},\"en-us\":{\"instance Name\":\"DBSS-test\",\"VPC\":\"default_vpc\",\"Subnet\":\"subnet-af32\"}}}" } ], "promotion_info" : "", "enterprise_project_id" : "0", "tags" : [ { "key" : "key_test", "value" : "1" } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称。取值范围： 只能由中文字符、英文字母、数字、下划线、中划线组成，且长度小于等于64个字符。 flavor_ref 是 String 云服务器使用的规格ID vpc_id 是 String 虚拟私有云的ID availability_zone 是 String 云服务器对应可用分区信息。(两个主备分区，中间用“,”分割，例如az1.dc1,az2.dc2)。 enterprise_project_id 否 String 企业项目ID。对接EPS必输。 nics 是 Array of nics objects 云服务器对应的网卡信息 security_groups 是 Array of security_groups objects 云服务器对应安全组信息 comment 否 String 备注信息 region 是 String 云服务器所在区域ID cloud_service_type 是 String 服务类型： hws.service.type.dbss charging_mode 是 Integer 计费模式： 0: 包周期计费 1: 按需计费 period_type 是 Integer -订购周期类型 0: 天 1：周 2：月 3：年 4: 小时 5: 绝对时间 period_num 是 Integer 订购周期数 subscription_num 是 Integer 订购数量： DBSS只支持订购1套，不支持多套 product_infos 是 Array of product_infos objects 产品信息列表 tags 否 Array of KeyValueBean objects 资源标签 promotion_info 否 String 折扣信息 is_auto_renew 否 Integer 自动续费 1: 自动续费 0: 不自动续费 表4 nics 参数 是否必选 参数类型 描述 subnet_id 是 String 网卡对应的子网ID ip_address 否 String IP地址，不填或空字符串为自动分配 表5 security_groups 参数 是否必选 参数类型 描述 id 是 String 云服务器对应的安全组ID，会对创建云服务器中配置的网卡生效 表6 product_infos 参数 是否必选 参数类型 描述 product_id 是 String 产品ID cloud_service_type 是 String 服务类型： hws.service.type.dbss resource_type 是 String 资源类型: hws.resource.type.dbss resource_spec_code 是 String 资源规格：- dbss.bypassaudit.low- dbss.bypassaudit.medium- dbss.bypassaudit.high product_spec_desc 否 String 产品规格的中英文描述，规格包含：主机名称、规格、虚拟私有云、子网。json字符串格式 ：{"specDesc":{"zh-cn":{"主机名称":"value1","规格":"value2","虚拟私有云":"value3","子网":"value4"},"en-us":{"Instance Name":"value1","Edition":"value2","VPC":"value3","Subnet":"value4"}}} 表7 KeyValueBean 参数 是否必选 参数类型 描述 key 是 String 键 value 否 String 值

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 resources Array of resources objects 资源实例列表 total_count Integer 总记录数 表8 resources 参数 参数类型 描述 resource_id String 资源ID resource_name String 资源名称，资源没有名称时默认为空字符串，eip返回ip地址。 resource_detail Object 资源详情。 资源对象，用于扩展，默认为空。 tags Array of tags objects 标签列表，没有标签默认为空数组 sys_tags Array of sys_tags objects 仅op_service权限才可以可以获取此字段： 目前只包含一个resource_tag 结构体 key：_sys_enterprise_project_id value：企业项目id，0表示默认企业项目 非op_service场景不能返回此字段 表9 tags 参数 参数类型 描述 key String 键 value String 值 表10 sys_tags 参数 参数类型 描述 key String 键 value String 值 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表13 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应示例 状态码： 200 成功 { "resources" : [ { "resource_detail" : null, "resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "5aa119a8-d25b-45a7-8d1b-88e127885635" } ] } ], "total_count" : 1000} 状态码： 400 失败 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }}

请求示例 /v1/{project_id}/{resource_type}/resource-instances/filter{ "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ] } ]}

URI POST /v1/{project_id}/{resource_type}/resource-instances/filter 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID resource_type 是 String 资源类型。 auditInstance 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 查询记录数（action为count时无此参数）如果action为filter默认为1000，limit最多为1000,不能为负数，最小值为1。 offset 否 String 索引位置，偏移量（action为count时无此参数）从第一条数据偏移offset条数据后开始查询，如果action为filter默认为0（偏移0条数据，表示从第一条数据开始查询）,必须为数字，不能为负数。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 matches 否 Array of matches objects 搜索字段,key为要匹配的字段，如resource_name等。value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。 根据key的值确认是否需要模糊匹配，如resource_name默认为模糊搜索（不区分大小写），如果value为空字符串精确匹配（多数服务不存在资源名称为空的情况，因此此类情况返回空列表）。resource_id为精确匹配。第一期只做resource_name，后续再扩展。 not_tags 否 Array of TagKeyValuesBean objects 不包含标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回不包含标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据 tags 否 Array of TagKeyValuesBean objects 包含标签，最多包含50个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据 tags_any 否 Array of TagKeyValuesBean objects 包含任意标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据 not_tags_any 否 Array of TagKeyValuesBean objects 不包含任意标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回不包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据 sys_tags 否 TagKeyValuesBean object 仅op_service权限可以使用此字段做资源实例过滤条件。目前TMS调用时只包含一个tag结构体。key：_sys_enterprise_project_idvalue：企业项目id列表目前TMS调用时，key下面只包含一个value。0表示默认企业项目sys_tags和租户标签过滤条件（without_any_tag 、tags、tags_any、not_tags、not_tags_any）不能同时使用无sys_tags时按照tag接口处理，无tag过滤条件时返回全量数据 without_any_tag 否 Boolean 不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段 表5 matches 参数 是否必选 参数类型 描述 key 是 String 键，目前仅支持：resource_name value 是 String 值，需要匹配的资源名称 表6 TagKeyValuesBean 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个unicode字符。 key不能为空。(搜索时不对此参数做字符集校验)，key不能为空或者空字符串，不能为空格，校验和使用之前先trim 前后半角空格 values 是 Array of strings 值列表。每个值最大长度255个unicode字符，校验和使用之前先trim 前后半角空格。 value可为空数组但不可缺省。 如果values为空列表，则表示any_value（查询任意value）。value之间为或的关系

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 DBSS.10000001 Enter a valid request message 请求消息格式非法 检查参数 400 DBSS.10020101 Enter a valid request message 获取规格列表失败 检查参数 400 DBSS.10020102 Enter a valid request message 操作数据库失败 检查参数 400 DBSS.10020118 Failed to add database, exceeding the limit 添加数据库失败,超出数量限制 删除不需要的数据库或购买新实例 400 DBSS.10020140 Illegal order ID 订单ID不符合要求 检查订单ID 400 DBSS.100210016 Insufficient quota 配额不足 联系管理员 400 DBSS.10020021 Invalid request parameter ID. 请求ID参数不合法 检查参数 401 DBSS.10020100 Failed to authenticate the token in the request 请求所带的Token认证失败 检查token 404 DBSS.10021004 E CS can not found the request page ECS服务器无法找到被请求页面 检查ecs路径配置 500 DBSS.11000000 Internal system exception. Contact technical support engineers 系统内部异常，请联系技术支持人员 联系管理员 父主题： 附录

响应示例 状态码： 200 成功 { "rules" : [ { "id" : "n34W2ngBo47GiyUSKOVl", "name" : "Passport NO.", "type" : "BUILD_IN", "regex" : "-", "mask_value" : "###", "status" : "ON", "operate_time" : "2030-01-01 00:00:06" }, { "id" : "nn4W2ngBo47GiyUSKOVP", "name" : "Military officer card NO.", "type" : "BUILD_IN", "regex" : "-", "mask_value" : "###", "status" : "ON", "operate_time" : "2030-01-01 00:00:05" }, { "id" : "nX4W2ngBo47GiyUSKOU9", "name" : "Ethnicity", "type" : "BUILD_IN", "regex" : "-", "mask_value" : "###", "status" : "ON", "operate_time" : "2030-01-01 00:00:04" }, { "id" : "mn4W2ngBo47GiyUSKOUO", "name" : "GPS Information", "type" : "BUILD_IN", "regex" : "-", "mask_value" : "###", "status" : "ON", "operate_time" : "2030-01-01 00:00:01" } ], "total" : 6} 状态码： 400 请求参数错误 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }} 状态码： 500 服务器内部错误 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }}

URI GET /v1/{project_id}/{instance_id}/dbss/audit/sensitive/masks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID instance_id 是 String 实例ID。可在查询实例列表接口的ID字段获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 偏移量 limit 否 String 查询记录数

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 rules Array of rules objects 规则列表 total Integer 总数 表5 rules 参数 参数类型 描述 id String 规则ID name String 规则名称 type String 规则类型 regex String 规则正则表达式 mask_value String 替换值 status String 规则状态 operate_time String 操作时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tags Array of tags objects 标签列表 表4 tags 参数 参数类型 描述 key String 键。最大长度128个字符。 values Array of strings 值列表。每个值最大长度255个字符。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应示例 状态码： 200 成功 { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ]} 状态码： 400 失败 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }}

URI GET /v2/{project_id}/{instance_id}/audit/agents/{agent_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID instance_id 是 String 实例ID。可在查询实例列表接口的ID字段获取。 agent_id 是 String agent ID。可在查询数据库agent列表接口ID字段获取。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表5 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应示例 状态码： 200 请求已成功。 { "result" : "SUC CES S"} 状态码： 400 请求参数有误。 { "error" : { "error_code" : "DBSS.XXX", "error_msg" : "XXX" }} 状态码： 403 认证失败。 { "error" : { "error_code" : "DBSS.XXX", "error_msg" : "XXX" }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应示例 状态码： 200 成功 { "servers" : [ { "name" : "DBSS-Test", "comment" : "", "connect_ipv6" : null, "status" : "ACTIVE", "task" : "NO_TASK", "id" : "8c53ed03-8ed7-4ff2-ad97-7b2d6d1dd364", "specification" : "Low | 3 Proxy", "zone" : "cn-cmcc1a-01", "created" : "2021-04-21 04:37:54", "expired" : null, "subnet_id" : "97ef0bb5-3759-4db4-aa49-0d087ed49ce5", "cpu" : 4, "ram" : 16384, "region" : "cn-cmcc1", "version" : "21.04.16.164614", "charge_model" : "Demand", "remain_days" : null, "config_num" : 1, "effect" : null, "scene" : null, "connect_ip" : "192.168.0.229", "port_id" : "dc4bd420-e01c-4d12-a7ff-814f17c63079", "resource_id" : "062212d8-8e30-4783-9671-43f3f1f3bb1e", "vpc_id" : "76d98391-5abc-46ed-b8a8-f664202cb166", "security_group_id" : "f0fbec06-bcf6-4c7e-99fa-f0ddfbb1d9bd", "resource_spec_code" : "dbss.bypassaudit.low", "keep_days" : null, "new_version" : null, "database_limit" : 3 } ], "total" : 1} 状态码： 400 失败 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 servers Array of AuditInstanceListBean objects 实例信息列表 total Integer 总数 表5 AuditInstanceListBean 参数 参数类型 描述 charge_model String 付费模式 Period：包周期 Demand：按需。 comment String 备注信息。 config_num Integer 配置的数据库总数。 connect_ip String 连接地址。 connect_ipv6 String ipv6连接地址。 cpu Integer CPU个数 created String 创建时间 database_limit Integer 支持的数据库总数 effect Integer 实例结果状态 1:冻结可释放 2:冻结不可释放 3:冻结后不可续费 expired String 过期时间 id String ID keep_days String 剩余天数 name String 实例别名 new_version String 如果有返回，则需要升级，如果没有，则为null。 port_id String 绑定弹性IP的port ID ram Integer 内存 region String 实例所在region remain_days String 到期天数 resource_id String 资源ID resource_spec_code String 实例的规格 scene String 场景 security_group_id String 安全组 specification String 实例规格 status String 实例状态 SHUTOFF :已关闭 ACTIVE: 运行中，允许任何操作 DELETING: 删除中，不允许任何操作 BUILD: 创建中，不允许任何操作 DELETED: 已删除，不需要展示 ERROR: 故障，只允许删除 HAWAIT: 等待备机创建成功，不允许任何操作 FROZEN: 已冻结，只允许续费、绑定/解绑 UPGRADING: 升级中，不允许升级操作 subnet_id String 子网ID task String 任务状态 powering-on: 正在开启，实例可以绑定、解绑 powering-off: 正在关闭，实例可以绑定、解绑 rebooting: 正在重启，实例可以绑定、解绑 delete_wait: 等待删除，集群与实例不允许任何操作 NO_TASK: 不展示 version String 实例的当前版本 vpc_id String 虚拟私有云 zone String 可用区 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应示例 状态码： 200 成功 { "total_num" : 3, "alarm_log" : [ { "id" : "99AJFI8BZEbGVdGbOczC", "alarmLife" : "ON", "sendEmail" : true, "alarm_time" : "2024-04-25 06:55:00", "alarm_type" : "RISK_DISK", "alarm_fix_time" : null, "alarm_status" : "UNDO", "alarm_description" : "DISK USAGE 5%", "alarm_risk" : "HIGH" }, { "id" : "9tAJFI8BZEbGVdGbOcy4", "alarmLife" : "ON", "sendEmail" : true, "alarm_time" : "2024-04-25 06:55:00", "alarm_type" : "RISK_MEMORY", "alarm_fix_time" : null, "alarm_status" : "UNDO", "alarm_description" : "MEMORY USAGE 53.54%", "alarm_risk" : "HIGH" }, { "id" : "9dAJFI8BZEbGVdGbOcyq", "alarmLife" : "ON", "sendEmail" : true, "alarm_time" : "2024-04-25 06:55:00", "alarm_type" : "RISK_CPU", "alarm_fix_time" : null, "alarm_status" : "UNDO", "alarm_description" : "CPU USAGE 1.0%", "alarm_risk" : "HIGH" } ]} 状态码： 400 请求参数错误 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }} 状态码： 500 服务器内部错误 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }}

请求示例 /v1/{project_id}/{instance_id}/audit/alarm-log{ "time" : { "time_range" : "DAY", "start_time" : null, "end_time" : null }, "risk" : null, "type" : null, "status" : null, "page" : 1, "size" : 100}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 total_num Integer 总条数 alarm_log Array of alarm_log objects 告警列表 表6 alarm_log 参数 参数类型 描述 id String 告警ID alarmLife String 告警状态 ON OFF sendEmail Boolean 是否发送邮件 alarm_time String 告警发生时间 alarm_type String 告警类型 RISK_RULE: 风险规则 RISK_CPU: CPU超限 RISK_MEMORY: 内存超限 RISK_DISK: 磁盘超限 RISK_DISK_CAPACITY: 磁盘容量不足六个月 RISK_BACKUP: 备份失败 AUDIT_QPS_OVERFLOW: 流量超限入库延迟告警 RISK_AGENT: Agent异常 AUDIT_BACKUP_FAILED: 实例备份失败(运维侧) alarm_fix_time String 告警恢复时间 alarm_status String 告警确认状态 DONE: 已确认 UNDO: 未确认 alarm_risk String 告警风险等级 LOW MEDIUM HIGH alarm_description String 告警描述信息 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 time 是 time object 时间 risk 否 String 风险级别 LOW MEDIUM HIGH type 否 String 告警类型 RISK_RULE: 风险规则 RISK_CPU: CPU超限 RISK_MEMORY: 内存超限 RISK_DISK: 磁盘超限 RISK_DISK_CAPACITY: 磁盘容量不足六个月 RISK_BACKUP: 备份失败 AUDIT_QPS_OVERFLOW: 流量超限入库延迟告警 RISK_AGENT: Agent异常 AUDIT_BACKUP_FAILED: 实例备份失败(运维侧) status 否 String 告警确认状态 DONE: 已确认 UNDO: 未确认 page 否 Integer 页码 size 否 Integer 每页条数 表4 time 参数 是否必选 参数类型 描述 time_range 否 String 时间范围。和start_time，end_time不能同时使用，同时传该参数优先级更高。枚举值 HALF_HOUR, HOUR, THREE_HOUR, TWELVE_HOUR, DAY, WEEK, MONTH; start_time 否 String 开始时间，必须和end_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间 end_time 否 String 结束时间，必须和start_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 agent_id 是 String 审计agent的ID。可在查询数据库agent列表接口ID字段获取。 status 是 Integer Agent开关状态 1：开启 0：关闭

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应示例 状态码： 200 请求已成功。 { "result" : "SUCCESS"} 状态码： 400 请求参数有误。 { "error" : { "error_code" : "DBSS.XXX", "error_msg" : "XXX" }} 状态码： 403 认证失败。 { "error" : { "error_code" : "DBSS.XXX", "error_msg" : "XXX" }}

响应示例 状态码： 200 成功 { "project_id" : "0250cb8a80c24c0b9f20f557cb159aad", "cpu" : 796, "ram" : 1622016, "audit_quota" : 1} 状态码： 400 客户端错误 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 project_id String 项目ID。 audit_quota Long 审计实例剩余配额。 cpu Long CPU剩余配额。 ram Long 内存剩余配额。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表5 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应示例 状态码： 200 成功 { "status" : "OFF", "action" : " LOG IN,SELECT,INSERT", "schemas" : [ { "schema" : "dbss_audit", "table" : null, "column" : null } ], "rank" : 6, "ignore_case" : false, "rule_id" : "AWT0HznX7At9UslqwTfm", "rule_name" : "risk_rule_name_00", "risk_level" : "MEDIUM", "db_ids" : "11111,22222", "execution_symbol" : "GREATER", "execution_time" : 10000, "affect_symbol" : "GREATER", "affect_rows" : 30, "client_ips" : "192.168.0.1"} 状态码： 400 请求参数错误 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }} 状态码： 500 服务器内部错误 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }}