更新三方托管应用注册的服务回调URL信息
路径 | /industry/notification/callback/update |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
serviceType | Int | 是 | 0:customData, 1:masterData, 2:organizationData, 3:alarmData, 4:factoryData, 5:otherData | |
needResVerify | Boolean | 是 | true or false | 是否需要返回参数验签 |
name | String | 是 | 服务名称,租户维度服务名唯一 | |
securityInfo | String | 否 | { "signType": "SIGNATURE", "signAlgorithm": "APP_SECRET_SIGN", "signKey": "25233865" } | 当needReqSign或者needResVerify为true时,三方服务安全配置信息JSON对象 |
description | String | 否 | 三方服务描述 | |
serviceId | Long | 是 | 服务Id | |
reqProtocol | String | 是 | https or http | 请求协议, https or http |
uri | String | 是 | 三方服务URI | |
needReqSign | Boolean | 是 | true or false | 请求是否需要加签 |
properties | String | 是 | {"http_method_type" : "POST"} | 调用模式个性化数据 |
appId | String | 否 | 多租户SaaS应用的appId |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
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.1");
// 设置参数
request.putParam("serviceType", "value0");
request.putParam("needResVerify", value1");
request.putParam("name", value2");
request.putParam("securityInfo", value3");
request.putParam("description", value4");
request.putParam("serviceId", value5");
request.putParam("reqProtocol", value6");
request.putParam("uri", value7");
request.putParam("needReqSign", value8");
request.putParam("properties", value9");
request.putParam("appId", value10");
// 如果需要,设置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/notification/callback/update", request, true, headers);
System.out.println(
"response code = " + response.getCode()
+ " response = " + new String(response.getBody(), "UTF-8")
+ " headers = " + response.getHeaders().toString()
);
正常返回示例
JSON
格式
{
"id": "997bb515-6b1f-4c09-a873-cb08f3cf68d2",
"code": 200,
"message": null,
"localizedMsg": null
}
异常返回示例
JSON
格式
{
"id": "f149f51a-c28c-46b1-b8e7-5e12ffd2db1e",
"code": 20600,
"message": "check uri ssrf failed",
"localizedMsg": "check uri ssrf failed"
}
错误码
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. | 系统错误 |