更新时间:2022-03-23 GMT+08:00
分享

查询规则

功能介绍

查询规则

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/link/instances/{instance_id}/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度:0

最大长度:32

instance_id

String

实例ID

最小长度:0

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示条目数量,最大数量999,超过999后只返回999

最小值:0

最大值:999999

缺省值:10

app_id

String

应用ID

最小长度:0

最大长度:64

name

String

规则名称

最小长度:0

最大长度:64

offset

Integer

偏移量,表示从此偏移量开始查询, offset大于等于0

最小值:0

最大值:999999

缺省值:0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:100000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

最小值:0

最大值:9999999999999999

size

Integer

本次返回数量

最小值:0

最大值:999

items

Array of Rule objects

规则列表

表5 Rule

参数

参数类型

描述

permissions

Array of strings

权限

rule_id

Integer

规则ID

最小值:1

最大值:99999999999999999

name

String

规则名称,支持英文大小写,数字,下划线和中划线,长度1-64

最小长度:1

最大长度:64

app_id

String

应用ID

最小长度:0

最大长度:64

app_name

String

应用名称

最小长度:0

最大长度:256

description

String

描述

最小长度:0

最大长度:200

status

Integer

规则状态 0-启用 1-停用

最小值:0

最大值:10

data_parsing_status

Integer

数据解析状态,ENABLE时data_parsing必填 0-启用 1-停用

最小值:0

最大值:10

sql_field

String

SQL查询字段

最小长度:0

最大长度:2000

sql_where

String

SQL查询条件

最小长度:0

最大长度:2000

rule_express

String

完整的规则表达式

最小长度:0

最大长度:2000

created_user

CreatedUser object

创建时的用户

last_updated_user

LastUpdatedUser object

最后更新时的用户

created_datetime

Long

创建时间,timestamp(ms),使用UTC时区

最小值:1

最大值:99999999999999999

last_updated_datetime

Long

最后修改时间,timestamp(ms),使用UTC时区

最小值:1

最大值:99999999999999999

表6 CreatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度:0

最大长度:64

user_name

String

用户名

最小长度:0

最大长度:64

表7 LastUpdatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度:0

最大长度:64

user_name

String

用户名

最小长度:0

最大长度:64

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

请求示例

GET /{project_id}/link/instances/{instance_id}/rules

响应示例

状态码: 200

OK

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "permissions" : [ "read", "access", "delete", "modify" ],
    "rule_id" : 702244,
    "name" : "rule",
    "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98",
    "app_name" : "app-link",
    "description" : null,
    "status" : 0,
    "data_parsing_status" : 1,
    "sql_field" : null,
    "sql_where" : null,
    "rule_express" : null,
    "created_user" : {
      "user_id" : "",
      "user_name" : "user"
    },
    "last_updated_user" : {
      "user_id" : "",
      "user_name" : "user"
    },
    "created_datetime" : 1607598152997,
    "last_updated_datetime" : 1607598152997
  } ]
}

状态码: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-rule.query]. Parameter is [X-Auth-Token]. Processor is [header].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码: 404

Not Found

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Not Found",
  "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01"
}

状态码: 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close