# 获取killOp规则列表-ObtainingthekillOpRuleList #### 接口说明 获取killOp规则列表。 #### 约束说明 - 仅支持副本集，集群实例。 - 仅支持数据库版本3.4版本及以后版本。 - 仅支持执行节点规格4U及以上。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DDS/doc?api=ShowKillOpRuleRuleList)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:instance:getKillOpRule | read | instance | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | - | - | #### URI - URI格式 GET /v3/{project_id}/instances/{instance_id}/kill-op-rule - URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/2900b7b8d03e4619b8db8d43bc6234ee/instances/70ddf44609734098a8d333f25a368976in02/kill-op-rule?namespaces=test.ym\&plan_summary=COLLSCAN 表1请求参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 | | project_id | 是 | String | 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 | | instance_id | 是 | String | 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | operation_types | 否 | String | Sql语句操作类型。 - insert，表示插入语句。 - update，表示更新语句。 - query，表示查询语句。 - command，表示命令语句。 - remove，表示删除语句。 - getmore，表示获取更多数据语句。 | | namespaces | 否 | String | 表命名空间。取值格式：库名或者库名.表名。 - 可为空，表示不做限制。 - 单独库名，表示对某个库下的所有集合生效。 - 库名.表名，表示对具体库下的具体的集合生效。 | | status | 否 | String | killOp规则状态。 - ENABLED，规则生效中。 - DISABLED，规则禁用中。 | | plan_summary | 否 | String | 执行计划。默认值空，表示不做限制。 - COLLSCAN - SORT_KEY_GENERATOR - SKIP - LIMIT - GEO_NEAR_2DSPHERE - GEO_NEAR_2D - AGGREGATE - OR | | offset | 否 | Integer | 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。取值必须为数字，不能为负数。 | | limit | 否 | Integer | 查询个数上限值。 - 取值范围: 1\~100。 - 不传该参数时，默认查询前100条信息。 | #### 请求消息 - 参数说明 无。 - 请求示例 无。 #### 响应消息 - 参数说明 表3响应Body参数 | 参数 | 参数类型 | 说明 | |:---|:---|:---| | rules | Array of [表4] | 列表。 | | total_count | Integer | 总数。 | 表4KillOpRule参数 | 参数 | 参数类型 | 说明 | |:---|:---|:---| | id | String | killOp规则ID。 | | operation_types | String | Sql语句操作类型。最多支持同时选择6种语句类型。同时选择多种类型时，匹配任意一种类型时规则生效。 - insert，表示插入语句。 - update，表示更新语句。 - query，表示查询语句。 - command，表示命令语句。 - remove，表示删除语句。 - getmore，表示获取更多数据语句。 | | status | String | killOp规则状态。 - ENABLED，规则生效中。 - DISABLED，规则禁用中。 | | namespaces | String | 表命名空间。取值格式：库名或者库名.表名。同时配置多组信息时，匹配任意一组信息时规则生效。 - 目前仅支持配置一组信息 - 可为空，表示不做限制。 - 单独库名，表示对某个库下的所有集合生效。 - 库名.表名，表示对具体库下的具体的集合生效。 | | client_ips | String | 客户端连接IP。 - 只支持IPV4。 - 可为空，表示不做限制。 - 最多支持配置5个IP，同时配置多个IP时，匹配任意一个IP时规则生效。 | | plan_summary | String | 执行计划。默认值空，表示不做限制。 - COLLSCAN - SORT_KEY_GENERATOR - SKIP - LIMIT - GEO_NEAR_2DSPHERE - GEO_NEAR_2D - AGGREGATE - OR | | max_concurrency | Integer | 最大并发数。 取值：不能为负数，可为空，默认为0，表示不做限制，最小值为1，最大值为100000。 | | secs_running | Integer | 单条操作最大运行时长。 取值：不能为负数，可为空，默认为0，表示不做限制。单位：s。最小值为2，最大值为86400。 | | node_type | String | 节点类型。 - mongos_shard，表示同时在mongos和shard节点生效。 - mongos，表示只在集群mongos节点生效。 - shard，表示只在集群shard节点生效。 - replica，表示只在副本集节点生效。 | - 响应示例 killOp规则列表： ``` { "rules" : [ { "operation_types" : [ "query", "insert" ], "namespaces" : [ "db.collections" ], "client_ips" : [ "172.168.201.144" ], "status" : "ENABLED", "id" : "f6f2cea4-ce40-4d4c-9d2f-61253d215811", "plan_summary" : "COLLSCAN", "max_concurrency" : 0, "secs_running" : 5, "node_type" : "replica" } ], "total_count" : 1 } ``` #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。