查询租户订阅资源 - ListSubscriptionOrder
功能介绍
查询租户版本信息，注意：目前其中参数purchase、usage、smn互斥，同时只能有一个请求参数被命中，优先级为：smn > usage > purchase
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/subscriptions/orders
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户projectId |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
smn订阅偏移量 |
|
limit |
否 |
Integer |
smn订阅返回数量 |
|
page |
否 |
String |
订单资源详情信息枚举，DEFAULT:默认缺省值，获取开通的资源列表，不包含套餐包；PURCHASE：在DEFAULT基础上返回租户名下ECS数量；RESOURCE_LIST在DEFAULT基础上返回套餐包列表；USAGE：返回资源用量信息；SMN：返回已订阅的smn topic列表 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
X-Language |
是 |
String |
用户当前语言环境 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
csb_version |
String |
租户当前的版本信息 BASIC(基础版)，STANDARD（标准版），PROFESSIONAL（专业版），NA（无版本），大小写不敏感 |
|
ecs_count |
Integer |
ecs个数，当请求参数purchase=true时才会返回该值，否则为0 |
|
resources |
Array of SubscriptionResource objects |
资源列表 |
|
subscription_count |
Integer |
topic订阅条数，当请求参数为smn=true，返回该字段 |
|
subscriptions |
Array of SmnSubscription objects |
租户订阅信息，当请求参数为smn=true，会返回租户名下可订阅的smn topic列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
资源Id |
|
resource_type_name |
String |
资源名称 |
|
resource_size |
Integer |
资源规格 |
|
cloud_service |
String |
订单来源，默认数据为SecMaster |
|
resource_type |
String |
资源类型 |
|
resource_spec_code |
String |
资源规格编码 |
|
create_time |
String |
创建时间戳 |
|
expire_time |
String |
到期时间戳，只有按需资源有该字段 |
|
resource_status |
Integer |
资源状态，目前返回正常运行的资源，其状态值为0 |
|
order_id |
String |
订单Id，包周期资源有该字段 |
|
charging_mode |
String |
计费模式，目前有包周期（包年包月）PREPAID、按需POSTPAID，大小写不敏感 |
|
tag_list |
Array of SubscriptionTagInfo objects |
资源列表 |
|
usages |
Array of ResourceUsage objects |
资源使用量，当usage=true时返回该字段 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
键。 最大长度36个字符。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF） |
|
value |
String |
值。 最大长度43个字符，可以为空字符串。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF） |
|
create_time |
Long |
创建时间戳 |
|
update_time |
Long |
更新时间戳 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
unit |
String |
使用量单位，OPS 次，MB 流量体积MB，GB 流量体积GB |
|
resource_type_name |
String |
资源类型名称 |
|
source_resource_spec_code |
String |
源资源规格编码 |
|
resource_spec_code |
AnyType |
源资源规格编码 |
|
source_type |
String |
源资源类型编码 |
|
used_percent |
Double |
用量百分比 |
|
quota |
Double |
配额总量 |
|
used |
Double |
已用量 |
|
free |
Double |
剩余量 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
owner |
String |
租户project_id |
|
endpoint |
String |
订阅终端 |
|
protocol |
String |
终端协议，比如HTTPS协议，SMS协议，EMAIL协议，HTTP协议 |
|
subscription_urn |
String |
smn订阅的urn |
|
topic_urn |
String |
订阅topic对应的urn |
|
status |
Integer |
订阅状态 0：未确认 1：已确认 2：不需要确认 3：已取消确认 4：已经删除。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
用户历史订购信息响应 |
|
403 |
权限不足 |
错误码
请参见错误码。
