淘宝开放平台

登录
文档中心 > API类目 > 电子面单API

电子面单API

cainiao.waybill.cloudprint.simulation.heartbeat (电子面单云打印外部平台代理应用心跳检测接口)

电子面单云打印外部平台代理应用心跳检测接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
cloud_print_platform_heart_beat_dto CloudPrintPlatformHeartBeatDTO 必须 外部平台心跳检测DTO，用于注册外部平台代理的信息数据
  • └ proxy_ip
  • String
  • 必须
  • 127.0.0.1
  • 代理程序的固定IP地址
  • └ business_id
  • String
  • 必须
  • test
  • 业务ID，由代理平台传入区分不同业务线的云打印代理
  • platform_info_list
  • CloudPrintPlatformInfoDTO []
  • 必须
  • [ { "aliveStatus": "alive", "platformCode": "PDD" }, { "aliveStatus": "alive", "platformCode": "DOUYIN" }, { "aliveStatus": "dead", "platformCode": "KUAISHOU" }, { "aliveStatus": "alive", "platformCode": "JD" } ]
  • 平台信息
  • └ alive_status
  • String
  • 必须
  • 存活alive，死亡dead
  • 平台存活状态 * @see CloudPrintProxyStatusEnum#getStatusCode
  • └ platform_code
  • String
  • 必须
  • PDD，DOUYIN，JD，KUAISHOU
  • 平台code * @see CloudPrintPlatformEnum#getPlatformCode
  • proxy_performance
  • CloudPrintPlatformProxyPerformanceDTO
  • 必须
  • 代理系统性能数据
  • └ memory_percent
  • Number
  • 必须
  • 30
  • 内存使用率百分比
  • └ cpu_percent
  • Number
  • 必须
  • 30
  • CPU使用率百分比

响应参数

名称 类型 示例值 描述
ret_data Boolean true 是否成功
ret_success Boolean true 是否成功
ret_error_message String error message 错误信息
ret_error_code String error code 错误码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoWaybillCloudprintSimulationHeartbeatRequest req = new CainiaoWaybillCloudprintSimulationHeartbeatRequest();
CainiaoWaybillCloudprintSimulationHeartbeatRequest.CloudPrintPlatformHeartBeatDTO obj1 = new CainiaoWaybillCloudprintSimulationHeartbeatRequest.CloudPrintPlatformHeartBeatDTO();
obj1.setProxyIp("127.0.0.1");
obj1.setBusinessId("test");
List<CainiaoWaybillCloudprintSimulationHeartbeatRequest.CloudPrintPlatformInfoDTO> list3 = new ArrayList<CainiaoWaybillCloudprintSimulationHeartbeatRequest.CloudPrintPlatformInfoDTO>();
CainiaoWaybillCloudprintSimulationHeartbeatRequest.CloudPrintPlatformInfoDTO obj4 = new CainiaoWaybillCloudprintSimulationHeartbeatRequest.CloudPrintPlatformInfoDTO();
list3.add(obj4);
obj4.setAliveStatus("存活alive，死亡dead");
obj4.setPlatformCode("PDD，DOUYIN，JD，KUAISHOU");
obj1.setPlatformInfoList(list3);
CainiaoWaybillCloudprintSimulationHeartbeatRequest.CloudPrintPlatformProxyPerformanceDTO obj5 = new CainiaoWaybillCloudprintSimulationHeartbeatRequest.CloudPrintPlatformProxyPerformanceDTO();
obj5.setMemoryPercent(30L);
obj5.setCpuPercent(30L);
obj1.setProxyPerformance(obj5);
req.setCloudPrintPlatformHeartBeatDto(obj1);
CainiaoWaybillCloudprintSimulationHeartbeatResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<cainiao_waybill_cloudprint_simulation_heartbeat_response>
    <ret_data>true</ret_data>
    <ret_success>true</ret_success>
    <ret_error_message>error message</ret_error_message>
    <ret_error_code>error code</ret_error_code>
</cainiao_waybill_cloudprint_simulation_heartbeat_response>

异常示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

API测试工具 错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问
返回
顶部