更新时间:2024-12-27 GMT+08:00
分享

查询应用规则

功能介绍

查询应用规则。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/app-center/app-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

查询的偏移量。

limit

Integer

单次查询的大小[1-100]。

name

String

应用规则名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数。

items

Array of AppRule objects

规则列表。

表5 AppRule

参数

参数类型

描述

id

String

规则ID。

name

String

规则名称。

description

String

规则描述。

rule

Rule object

规则信息。

rule_source

String

规则来源。

create_time

String

创建时间。

update_time

String

更新时间。

表6 Rule

参数

参数类型

描述

scope

String

规则范围:

  • PRODUCT - 产品

  • PATH - 路径

product_rule

ProductRule object

产品规则信息,进程名称、产品名称、发布者的各项都需要匹配,为空或者表示任意匹配。 例如: 发布者:

产品名称:Huawei

进程名称:*

只要产品名称是Huawei的就可以认为是匹配的。

path_rule

PathRule object

路径规则信息,限制对应路径及子路径

表7 ProductRule

参数

参数类型

描述

identify_condition

String

识别条件。

publisher

String

发布者名称:

  1. 名称允许可见字符或空格,不可为全空格。

  2. 长度0~1024个字符。

  3. 为空或者*号表示任意匹配。

product_name

String

产品名称:

  1. 名称允许可见字符或空格,不可为全空格。

  2. 长度0~128个字符。

  3. 为空或者*号表示任意匹配。

process_name

String

进程名称:

  1. 名称允许可见字符或空格,不可为全空格。

  2. 长度0~128个字符。

  3. 为空或者*号表示任意匹配。

support_os

String

操作系统类型,仅内置规则存在该字段。

  1. 名称允许可见字符或空格,不可为全空格。

  2. 长度0~128个字符。

version

String

版本号:

  1. 名称允许可见字符或空格,不可为全空格。

  2. 长度0~128个字符。

  3. 为空或者*号表示任意匹配。

product_version

String

产品版本号:

  1. 允许可见字符。

  2. 长度0~128个字符。

表8 PathRule

参数

参数类型

描述

path

String

完整路径:

  1. 名称允许可见字符或空格,不可为全空格。

  2. 长度0~512个字符。

  3. 为空或者*号表示任意匹配。

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 405

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 503

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

响应示例

状态码: 200

成功响应。

{
  "count" : 0,
  "items" : [ {
    "id" : "string",
    "name" : "string",
    "description" : "string。",
    "rule" : {
      "scope" : "PRODUCT",
      "product_rule" : {
        "identify_condition" : "productName",
        "publisher" : null,
        "product_name" : "HUAWEI",
        "process_name" : "Huawei.exe",
        "support_os" : "Windows",
        "version" : "1.0.0.1",
        "product_version" : "1.0.0.1"
      },
      "path_rule" : {
        "path" : "D:\\\\tmp"
      }
    },
    "rule_source" : "string",
    "create_time" : "2024-12-25T07:03:42.629Z",
    "update_time" : "2024-12-25T07:03:42.629Z"
  } ]
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误,具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码

相关文档