本文导读

展开导读

文档首页/ 云客服/ API参考/ OMA接口参考/ 软件云对接接口/ 查询订购信息接口

查询订购信息接口

更新时间：2023-09-27 GMT+08:00

查看PDF

描述

提供给软件云调用，查询OMA侧保存的软件云订购信息。（目前提供给软件云官网试用）

接口方法

POST

接口URI

https://域名/rest/oma/softwareconsole/tenant/queryresource，例如域名是service.besclouds.com

请求说明

表1 请求头参数
序号	名称	参数类型	是否必选	说明
1	X-Auth-Token	string	True	软件云侧用户access-token值

请求参数

序号	名称	参数类型	是否必选	说明
1	limit	int	True	每页查询数小于100
2	offset	int	True	偏移量从0开始
3	startDate	long	false	开始订购时间时间戳
4	endDate	long	false	结束订购时间时间戳

响应说明

响应状态码: 200

表2 响应体参数
序号	名称	参数类型	是否必选	说明
1	result	object[]	true	结果
1.1	orderId	string	true	订单号
1.2	opType	string	true	类型
1.3	remark	string	true	remark
1.4	skuName	string	true	产品类型
1.5	modifyTime	string	true	修改时间
1.6	orderAmount	string	true	订单金额
1.7	procutName	string	true	计费模式
1.8	vdnId	string	true	vdnId
1.9	customerId	string	true	客户id
1.10	company	string	true	company
1.11	id	string	true	id
1.12	manualStatus	string	true	处理状态
1.13	cecTenantId	string	true	cecTenantId
1.14	amount	string	true	订购数量
1.15	periodNumber	string	true	订购周期（数量）
1.16	productId	string	true	计费模式code
1.17	autoStatus	string	true	自动处理状态
1.18	customerName	string	true	客户名称
1.19	cecExpireTime	string	true	过期时间手工计算
1.20	cecTenantName	string	true	cecTenantName
1.21	createSource	string	true	创建来源
1.22	periodType	string	true	订购周期（单位）
1.23	expireTime	string	true	过期时间
1.24	createTime	string	true	订购时间
1.25	skuCode	string	true	skuCode
1.26	cecFeatureType	string	true	特性类型
1.27	trialFlag	int	true	是否试用
1.28	retryTimes	string	true	重试次数
1.29	status	string	true	订单的实例状态 2：生效 8：失效 9：历史
2	count	string	true	记录总数
3	returnCode	string	true	返回响应码
4	description	string	true	描述

响应状态码: 401

表3 响应体参数
序号	名称	参数类型	是否必选	说明
1	schema	string	True	未授权：1. 请确认是否购买了客户服务云相关服务。 2. 系统管理员登陆客户服务云系统，进入“系统参数->统一公共配置->云客户配置”，确认软件云对接官网地址配置是否正确。3.确认请求头参数设置是否正确

响应状态码: 502

表4 响应体参数
序号	名称	参数类型	是否必选	说明
1	schema	string	True	业务失败

消息样例

场景描述：软件云调用接口查询订购信息
```
URL：/rest/oma/softwareconsole/tenant/queryresource
```

请求头:

{
    "X-Auth_Token":"0000000000srLl4pnoBc*************9DvgIB87KzYpxMdE9+vvzLZqYIw="
}

请求体：

{
"limit":"10",   
"offset":"0",
"startDate":1679558854000,
"endDate":1679558854001
}

响应头：

{
    "connection": "keep-alive", 
    "Content-Length": "16", 
    "Content-Type": "application/json%3Bcharset=UTF-8"
}

响应体：

{
"result": [{
		"orderId": "251679538126441114",
		"opType": "newInstance",
		"remark": null,
		"skuName": "电销型座席",
		"modifyTime": 1679558854000,
		"orderAmount": "36000",
		"procutName": "包月",
		"vdnId": "131",
		"customerId": "20220727032236821699",
		"company": "ttttttttttttt",
		"id": "1638814724192780290",
		"manualStatus": "0",
		"cecTenantId": "202303232614",
		"amount": "1",
		"periodNumber": "2",
		"productId": "0GbV000000wG80TFeSlU",
		"autoStatus": "2",
		"customerName": "zhangsan",
		"cecExpireTime": 1684829253000,
		"cecTenantName": "Tenant07323220",
		"createSource": "GTS",
		"periodType": "month",
		"expireTime": 1684722289000,
		"createTime": 1679558853000,
		"skuCode": "d52b28fa-e0a7-a8f7-8356-0f0aea54b862"
	}],
	"count": 1,
	"returnCode": "0",
	"description": "success"
}

父主题： 软件云对接接口

上一篇：客户信息查询接口

下一篇：华为工业云平台IMC回调接口

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消