根据服务Id查询注册的三方服务详情
路径 | /industry/notification/callback/query |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
serviceId | Long | 是 | 1 | 三方服务Id |
appId | String | 否 | 多租户SaaS应用的appId |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
响应结果 |
|
serviceId | Long |
服务Id |
|
name | String |
服务名称 |
|
serviceType | Int |
服务类型,0:customData, 1:masterData, 2:organizationData, 3:alarmData, 4:factoryData, 5:otherData |
|
reqProtocol | String |
请求协议, https or http |
|
uri | String |
服务URI |
|
needReqSign | Boolean |
请求是否需要加签 |
|
needResVerify | Boolean |
是否需要返回参数验签 |
|
securityInfo | String |
当needReqSign或者needResVerify为 T 时,三方服务安全配置信息json对象 |
|
needQosLimit | Boolean |
是否需要进行QOS控制 |
|
qosInfo | String |
当needQosLimit为 T 时,三方服务QOS配置信息json对象 |
|
properties | String |
调用模式个性化数据 |
|
description | 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("serviceId", "value0");
request.putParam("appId", value1");
// 如果需要,设置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/query", request, true, headers);
System.out.println(
"response code = " + response.getCode()
+ " response = " + new String(response.getBody(), "UTF-8")
+ " headers = " + response.getHeaders().toString()
);
正常返回示例
JSON
格式
{
"id": "5588b569-24c4-4860-90f4-840d1ac0e189",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"serviceType": 6,
"needResVerify": false,
"name": "industry_master_data",
"needQosLimit": false,
"serviceId": 4178,
"reqProtocol": "https",
"uri": "https://linkindustry.aliyun.com/data",
"needReqSign": false,
"properties": "{\"http_method_type\": \"POST\"}"
}
}
异常返回示例
JSON
格式
{
"id": "9e345030-5915-4cfa-8c9d-bd9b6f343b5a",
"code": 20500,
"message": "GW_DB_QUERY_FAIL",
"localizedMsg": "GW_DB_QUERY_FAIL",
"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 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
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 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 460 | request forbidden | 请求被禁止 |
200 | 22000 | Query Result is Empty | 查询结果为空 |
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 | 460 | request parameter error. | 请求参数错误 |
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. | 请求被禁止 |