计费管理相关接口

ZStack Cloud 5.3.40>ZStack CLoud开发手册>运营管理>计费管理相关接口

创建资源价格(CreateResourcePrice)

API请求

URLs

POST zstack/v1/billings/prices

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "resourceName": "cpu",     "timeUnit": "s",     "price": 100.0,     "dateInLong": 0.0   },   "systemTags": [],   "userTags": [] }

说明: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth cc882c434d65428091449452ab5eb2e3" \ -X POST -d '{"params":{"resourceName":"cpu","timeUnit":"s","price":100.0,"dateInLong":0.0}}' \ http://localhost:8080/zstack/v1/billings/prices

参数列表

名字	类型	位置	描述	可选值	起始版本
resourceName	String	body(包含在params结构中)	资源名称	cpu memory rootvolume datavolume snapshot gpu pubIpVmNicBandwidthOut pubIpVmNicBandwidthIn pubIpVipBandwidthOut pubIpVipBandwidthIn	0.6
resourceUnit (可选)	String	body(包含在params结构中)	资源计费单元	可选值根据resourceName而定	0.6
timeUnit	String	body(包含在params结构中)	计费时间单元		0.6
price	double	body(包含在params结构中)	单位价格		0.6
accountUuid (可选)	String	body(包含在params结构中)	账户UUID		0.6
dateInLong (可选)	Long	body(包含在params结构中)	长整型时刻		0.6
tableUuid (可选)	String	body(包含在params结构中)	价目表UUID		3.7.2
systemTags (可选)	List	body	系统标签		0.6
userTags (可选)	List	body	用户标签		0.6

说明:

ZStack Cloud支持创建资源价格时指定PCI设备，SystemTags增加PCI设备选项。
- 选项格式为：gpuOfferingUuid::UUID
- 例如：gpuOfferingUuid::634b48a7bca139d9944a0f95b0c2dddf
ZStack Cloud支持创建资源价格时自定义资源计费类型，SystemTags增加priceUserConfig选项。
- 选项格式为：priceUserConfig::xxx，XXX要求JSON字符串。

API返回

返回示例

{   "inventory": {     "uuid": "437ade61b17e4c658844fdacfb0fc6de",     "resourceName": "Volume",     "resourceUnit": "1",     "timeUnit": "s",     "price": 2.0   } }

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventory	PriceInventory	详情参考inventory	0.6

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
resourceName	String	资源名称	0.6
resourceUnit	String	资源计费单元	0.6
timeUnit	String	计费时间单元	0.6
price	Double	价格	0.6
dateInLong	Long	以长整型记录的时刻	0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
tableUuid	String	价目表UUID	3.7.1
pciDeviceOfferings	List	详情参考pciDeviceOfferings	2.4

#pciDeviceOfferings

名字	类型	描述	起始版本
priceUuid	String		2.4
pciDeviceOfferingUuid	String		2.4
createDate	Timestamp	创建时间	2.4
lastOpDate	Timestamp	最后一次修改时间	2.4

SDK示例

Java SDK

CreateResourcePriceAction action = new CreateResourcePriceAction(); action.resourceName = "cpu"; action.timeUnit = "s"; action.price = 100.0; action.dateInLong = 0.0; action.sessionId = "1360cf066fd547b9ae2d8f32beba717f"; CreateResourcePriceAction.Result res = action.call();

Python SDK

CreateResourcePriceAction action = CreateResourcePriceAction() action.resourceName = "cpu" action.timeUnit = "s" action.price = 100.0 action.dateInLong = 0.0 action.sessionId = "47ca95d22d8645ef8aef8dd0110cbd92" CreateResourcePriceAction.Result res = action.call()

删除资源价格(DeleteResourcePrice)

API请求

URLs

DELETE zstack/v1/billings/prices/{uuid}

Headers

OAuth: the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "OAuth: 5332b02080a141cc961457ad3b090fe4" \ -X DELETE http://localhost:8080/zstack/v1/billings/prices/a5c5bd6198824d89894cdd10969843ff

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	0.6
deleteMode (可选)	String	body	删除模式	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{     "error": {         "code": "SYS.1001",         "description": "A message or a operation timeout",         "details": "Create VM on KVM timeout after 300s"     } }

SDK示例

Java SDK

DeleteResourcePriceAction action = new DeleteResourcePriceAction(); action.uuid = "d56a8d3e103a3ae997f6daa087fa3ea8"; action.cutoffPrice = false; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DeleteResourcePriceAction.Result res = action.call();

Python SDK

DeleteResourcePriceAction action = DeleteResourcePriceAction() action.uuid = "d56a8d3e103a3ae997f6daa087fa3ea8" action.cutoffPrice = false action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" DeleteResourcePriceAction.Result res = action.call()

修改资源价格(UpdateResourcePrice)

API请求

URLs

PUT zstack/v1/billings/prices/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{   "updateResourcePrice": {     "setEndDateInLongBaseOnCurrentTime": false   },   "systemTags": [],   "userTags": [] }

说明: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"updateResourcePrice":{"setEndDateInLongBaseOnCurrentTime":false}}' http://localhost:8080/zstack/v1/billings/prices/bed31eb3ba76325ba6a1cef1a64c97a3/actions

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源价格UUID	3.7.2
endDateInLong (可选)	Long	body(包含在updateResourcePrice结构中)	资源价格生效截止时间	3.7.2
setEndDateInLongBaseOnCurrentTime (可选)	boolean	body(包含在updateResourcePrice结构中)	设置资源价格生效截止时间为当前时间	3.7.2
systemTags (可选)	List	body		3.7.2
userTags (可选)	List	body		3.7.2

API返回

返回示例

{   "inventory": {     "uuid": "d7d2b639707c3e158f9f94cdfff8dc88",     "resourceName": "Volume",     "resourceUnit": "1",     "timeUnit": "s",     "price": 2.0,     "dateInLong": 1.510669257141E12,     "endDateInLong": 1.511029257141E12   } }

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.7.2
inventory	PriceInventory	详情参考inventory	3.7.2

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
resourceName	String	资源名称	0.6
resourceUnit	String	资源计费单元	0.6
timeUnit	String	计费时间单元	0.6
price	Double	价格	0.6
dateInLong	Long	以长整型记录的时刻	0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
tableUuid	String	价目表UUID	3.7.2
pciDeviceOfferings	List	详情参考pciDeviceOfferings	2.4

#pciDeviceOfferings

名字	类型	描述	起始版本
priceUuid	String		2.4
pciDeviceOfferingUuid	String		2.4
createDate	Timestamp	创建时间	2.4
lastOpDate	Timestamp	最后一次修改时间	2.4

SDK示例

Java SDK

UpdateResourcePriceAction action = new UpdateResourcePriceAction(); action.uuid = "bed31eb3ba76325ba6a1cef1a64c97a3"; action.setEndDateInLongBaseOnCurrentTime = false; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; UpdateResourcePriceAction.Result res = action.call();

Python SDK

UpdateResourcePriceAction action = UpdateResourcePriceAction() action.uuid = "bed31eb3ba76325ba6a1cef1a64c97a3" action.setEndDateInLongBaseOnCurrentTime = false action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" UpdateResourcePriceAction.Result res = action.call()