文档

触发指定报警ID的报警消息

更新时间:
一键部署

触发指定报警ID的报警消息

路径

/industry/message/alarm/triggerById

版本号

1.0.2

协议

HTTPS

请求方法

POST

是否需要用户身份鉴权

可选

超时时间

5000

请求参数

名称

类型

是否必选

示例值

描述

alarmId

Long

101, 报警id,范围需大于100

报警定义ID

content

String

"this is a alarm message content"

报警消息的显示内容

receiverList

List

消息接收者列表的代码,说明:receiverType为organization时,传入组织id列表;receiverType为role时,传入角色id列表,receiverType为user时,传入人员的identityId列表

receiverType

String

role

接收者的类型,取值说明:role: 角色,organization:组织,user:人员

appId

String

sass应用的appId

employeeId

String

调用者的身份id,即iot的identityId

返回数据

名称

类型

示例值

描述

code

Int

响应码, 200: 成功

message

String

错误消息

localizedMsg

String

本地语言错误消息

示例

请求示例

// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();

ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");

SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);

IoTApiRequest request = new IoTApiRequest();

// 设置请求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 设置API版本号
request.setApiVer("1.0.2");

// 设置参数
request.putParam("alarmId", "value0");
request.putParam("content", value1");
request.putParam("receiverList", value2");
request.putParam("receiverType", value3");
request.putParam("appId", value4");
request.putParam("employeeId", value5");
// 如果需要,设置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");

// 设置请求参数域名, path, request, isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/industry/message/alarm/triggerById", request, true, headers);

System.out.println(
    "response code = " + response.getCode()
        + " response = " + new String(response.getBody(), "UTF-8")
        + " headers = " + response.getHeaders().toString()
);

正常返回示例

JSON 格式

{"code":200,"message":null,"localizedMsg":null,"data":null}

异常返回示例

JSON 格式

{"code":107520,"message":"报警id不存在","localizedMsg":"gateway.backend service error","data":null}

错误码

HttpCode

错误码

错误信息

描述

500

500

Internal Error

Internal Error

503

503

Service Unavailable

Service Unavailable

403

403

Request Limited

Request Limited

401

401

Empty Signature

Empty Signature

400

400

Request Format Error

Request Format Error

200

20003

Find Backend Error

Find Backend Error

200

20004

Backend Service Error

Backend Service Error

200

20055

Backend Service Invalid

Request Format Error

200

20056

Hsf Invoke Timeout

Hsf Invoke Timeout

200

401

Request Authorized Error

Request Authorized Error

200

403

Request Forbidden

Request Forbidden

200

500

Server Error

Server Error

200

500

server error.

系统错误

200

403

request forbidden.

请求被禁止

200

460

request parameter error.

请求参数错误

200

500

server error.

系统错误

200

460

request parameter error.

请求参数错误

200

460

request forbidden

请求被禁止

200

1009

SQL invoke error

SQL 执行出错

200

460

request parameter error.

请求参数错误

200

500

server error.

系统错误

200

403

request forbidden.

请求被禁止

200

403

request forbidden.

请求被禁止

200

460

request parameter error.

请求参数错误

200

500

server error.

系统错误

200

460

request parameter error.

请求参数错误

200

403

request forbidden.

请求被禁止

200

500

server error.

系统错误

200

460

request parameter error.

请求参数错误

200

500

server error.

系统错误

200

460

request parameter error.

请求参数错误

200

500

server error.

系统错误

200

403

request forbidden.

请求被禁止

200

500

server error.

系统错误

200

460

request parameter error.

请求参数错误

200

403

request forbidden.

请求被禁止

200

460

request parameter error.

请求参数错误

200

500

server error.

系统错误

200

403

request forbidden.

请求被禁止

200

403

request forbidden.

请求被禁止

200

500

server error.

系统错误

200

460

request parameter error.

请求参数错误

200

460

request parameter error.

请求参数错误

200

500

server error.

系统错误

200

107520

alarm id is not exist

报警id不存在

200

107521

alarm title should not be empty

报警title不允许为空

200

107522

alarm content should not be empty

报警内容不允许为空

200

107523

alarm level error

报警级别错误,只能为0,1,2

200

107524

rule bind alarm definition fail

规则关联报警定义失败

200

107525

alarm receiver type error

报警接收范围的类型错误,只能为role/organization/user

  • 本页导读 (0)
文档反馈