文档中心 > API类目 > 工具类API

alipay.data.dataservice.deployorder.detail.query (部署单查询接口)

海外部署时通过轮询该接口获取主站的变更部署单,与部署单反馈接口配合使用,完成服务的动态发布过程

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.data.dataservice.deployorder.detail.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
biz_ins_name String 必须 256 管控中心实例名称+唯一+通过该名称获取发布到该环境的部署单+无枚举值+通过页面配置自行定义 ant_prod
biz_create_begin Date 可选 10 描述:拉取的业务起始时间(不包含)
应用场景:管控中心启动后通过该参数获取增量发布的部署单
如何获取:获取本地部署单的最大时间
2017-11-09 11:00:00
page Number 必须 10 描述:页数,从1开始
应用场景:分页获取增量部署单
1
size Number 可选 10 每页大小 200

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
deploy_order_list DxDeployOrderInfo [] 选填 - 部署单列表
  • └ record_id
  • String
  • 必填
  • 256
  • 记录id
  • 82
  • └ biz_ns
  • String
  • 必填
  • 128
  • 决策服务自定义名字空间字段
  • 部署的名字空间
  • └ group
  • String
  • 必填
  • 128
  • 部署的分组名
  • lab_group
  • └ deploy_object_type
  • String
  • 必填
  • 64
  • 部署对象类型,共有4个类型:DECISION_RULE(决策规则),DECISION_ROUTER(决策分流规则),DECISION_ROUTER_PERCENT(决策策略分流百分比),DATA_SOURCE(数据源)
  • DECISION_RULE
  • └ deploy_event_type
  • String
  • 选填
  • 64
  • 部署事件类型,枚举值如下:
    ONLINE,OFFLINE,UPDATE,VERIFY
  • ONLINE
  • └ retry
  • Boolean
  • 选填
  • 10
  • 是否为重试部署单
  • false
  • └ pre_record_id
  • String
  • 选填
  • 128
  • 重试的记录id
  • 10001
  • └ deploy_payload
  • String
  • 选填
  • 2048
  • 部署单内容
  • {"deployConfig":"COMPILE201709/run/3ee0253fa8e4472fa11fcf128e9f294a_20170920111045_branch1-SNAPSHOT_1505901141006_tkltas44.jar"}
  • └ gmt_biz_create
  • Date
  • 选填
  • 64
  • 部署单业务创建时间
  • 2017-11-09 10:00:00

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayDataDataserviceDeployorderDetailQueryRequest request = new AlipayDataDataserviceDeployorderDetailQueryRequest();
request.setBizContent("{" +
"\"biz_ins_name\":\"ant_prod\"," +
"\"biz_create_begin\":\"2017-11-09 11:00:00\"," +
"\"page\":1," +
"\"size\":200" +
"  }");
AlipayDataDataserviceDeployorderDetailQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_data_dataservice_deployorder_detail_query_response":{
		"msg":"Success",
		"code":"10000",
		"deploy_order_list":[
			{
				"record_id":"82",
				"deploy_payload":"{\"deployConfig\":\"COMPILE201709/run/3ee0253fa8e4472fa11fcf128e9f294a_20170920111045_branch1-SNAPSHOT_1505901141006_tkltas44.jar\"}",
				"deploy_object_type":"DECISION_RULE",
				"biz_ns":"部署的名字空间",
				"retry":false,
				"group":"lab_group",
				"deploy_event_type":"ONLINE",
				"pre_record_id":"10001",
				"gmt_biz_create":"2017-11-09 10:00:00"
			}
		]
	}
}

异常示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_data_dataservice_deployorder_detail_query_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	}
}

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误 参数错误,请仔细检查参数
BIZ_ERROR 业务异常 业务内部异常
SYSTEM_ERROR 系统繁忙 系统错误,需要联系提供者排查
DX_INSTANCE_NAME_NOT_EXIST 管控中心实例名称不存在
DX_QUERY_SIZE_MAX_LIMIT 查询的页面大小超过了最大值200 调低页面大小
DX_QUERY_PAGE_ILLEGAL 页面参数非法 检查页面参数,必须是1到MAX_VALUE之间的正整数
DX_BIZ_DATE_FORMAT_ILLEGAL 开始时间格式非法 检查传入日期格式,格式为YYYY-MM-DD HH:MM:SS

公共错误码

返回
顶部