更新时间:2024-07-03 GMT+08:00
分享

创建规则

功能介绍

创建规则

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:0

最大长度:32

instance_id

String

实例ID。

最小长度:0

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:100000

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

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

最小长度:1

最大长度:64

app_id

String

应用ID。

最小长度:0

最大长度:64

description

String

描述,长度0-200。

最小长度:0

最大长度:200

status

Integer

规则状态,0-启用,1-停用,不填写时默认为0-启用。

最小值:0

最大值:10

data_parsing_status

Integer

数据解析状态,0-启用,1-停用,不填写时默认为1-禁用。

最小值:0

最大值:10

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

permissions

Array of strings

权限。

rule_id

Integer

规则ID。

最小值:1

最大值:99999999999999999

name

String

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

最小长度:1

最大长度:64

app_id

String

应用ID。

最小长度:0

最大长度:64

description

String

描述。

最小长度:0

最大长度:200

status

Integer

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

最小值:0

最大值:10

data_parsing_status

Integer

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

最小值:0

最大值:10

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

表5 CreatedUser

参数

参数类型

描述

user_id

String

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

最小长度:0

最大长度:64

user_name

String

用户名。

最小长度:0

最大长度:64

表6 LastUpdatedUser

参数

参数类型

描述

user_id

String

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

最小长度:0

最大长度:64

user_name

String

用户名。

最小长度:0

最大长度:64

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

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

最小长度:0

最大长度:64

error_msg

String

错误描述。

最小长度:0

最大长度:200

request_id

String

消息ID。

最小长度:0

最大长度:64

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

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

最小长度:0

最大长度:64

error_msg

String

错误描述。

最小长度:0

最大长度:200

request_id

String

消息ID。

最小长度:0

最大长度:64

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

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

最小长度:0

最大长度:64

error_msg

String

错误描述。

最小长度:0

最大长度:200

request_id

String

消息ID。

最小长度:0

最大长度:64

请求示例

创建一条规则,规则状态和数据解析状态均为启用。

{
  "name" : "rule",
  "app_id" : "ef3845be-091a-4ab5-869a-9de0025e2165",
  "description" : "rule",
  "status" : 0,
  "data_parsing_status" : 0
}

响应示例

状态码: 200

Created

{
  "permissions" : [ "read", "access", "delete", "modify" ],
  "rule_id" : 702244,
  "name" : "rule",
  "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98",
  "description" : "123",
  "status" : 0,
  "data_parsing_status" : 1,
  "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.save]. Parameter is [request]. Processor is [body].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码: 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID ff38023c-0854-4779-847d-72528e1f5da5 is correct.",
  "request_id" : "72b07918-f6a2-4721-81bf-f3fd5486025e-1619663576836-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

Created

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档