Updated on 2023-09-27 GMT+08:00

Querying Subscription Information

Description

This interface is invoked by the business software mall to query business software mall subscription information stored on the OMA. (Currently, this interface is provided for the business software mall official website for trial use.)

Method

POST

URI

https://Domain name/rest/oma/softwareconsole/tenant/queryresource (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameter

No.

Parameter

Type

Mandatory or Not

Description

1

X-Auth-Token

String

Yes

Value of access-token of a business software mall user

Request parameters

No.

Parameter

Type

Mandatory or Not

Description

1

limit

Integer

Yes

Number of records on each page. The value must be less than 100.

2

offset

Integer

Yes

Offset. The value must be greater than or equal to 0.

3

startDate

Long

No

Subscription start timestamp

4

endDate

Long

No

Subscription end timestamp

Response Description

  • Status code: 200
Table 2 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

result

Object []

Yes

Result

1.1

orderId

String

Yes

Order ID

1.2

opType

String

Yes

Type

1.3

remark

String

Yes

Remarks

1.4

skuName

String

Yes

Product type

1.5

modifyTime

String

Yes

Modification time

1.6

orderAmount

String

Yes

Order amount

1.7

procutName

String

Yes

Charging mode

1.8

vdnId

String

Yes

VDN ID

1.9

customerId

String

Yes

Customer ID

1.10

company

String

Yes

Company

1.11

id

String

Yes

ID

1.12

manualStatus

String

Yes

Processing status

1.13

cecTenantId

String

Yes

CEC tenant ID

1.14

amount

String

Yes

Number of subscriptions

1.15

periodNumber

String

Yes

Number of subscription periods

1.16

productId

String

Yes

Charging mode code

1.17

autoStatus

String

Yes

Automatic processing status

1.18

customerName

String

Yes

Customer name

1.19

cecExpireTime

String

Yes

Expiration time manually calculated

1.20

cecTenantName

String

Yes

CEC tenant name

1.21

createSource

String

Yes

Source

1.22

periodType

String

Yes

Subscription unit

1.23

expireTime

String

Yes

Expiration time

1.24

createTime

String

Yes

Subscription time

1.25

skuCode

String

Yes

SKU code

1.26

cecFeatureType

String

Yes

Feature type

1.27

trialFlag

Integer

Yes

Trial use or not

1.28

retryTimes

String

Yes

Maximum number of retry times

1.29

status

String

Yes

Order instance status

  • 2: effective
  • 8: expired
  • 9: historical

2

count

String

Yes

Total number of records

3

returnCode

String

Yes

Returned response code

4

description

String

Yes

Description

  • Status code: 401
Table 3 Response body parameter

No.

Parameter

Type

Mandatory or Not

Description

1

schema

String

Yes

Unauthorized operation. 1. Check whether you have purchased services related to the AICC. 2. Sign in to the AICC as the system administrator and check whether the value of Business Software Mall Official Website under System parameters > Unified Public Configuration > Cloud Customers is correct. 3. Check whether the request header parameter is correctly set.

  • Response status code: 502
Table 4 Response body parameter

No.

Parameter

Type

Mandatory or Not

Description

1

schema

String

Yes

Business failure

Example

  • Scenario: The business software mall invokes this interface to query subscription information.
    URL: /rest/oma/softwareconsole/tenant/queryresource
  • Request header
    {
        "X-Auth_Token":"0000000000srLl4pnoBc*************9DvgIB87KzYpxMdE9+vvzLZqYIw="
    }
  • Request body
    {
    "limit":"10",   
    "offset":"0",
    "startDate":1679558854000,
    "endDate":1679558854001
    }
  • Response header
    {
        "connection": "keep-alive", 
        "Content-Length": "16", 
        "Content-Type": "application/json%3Bcharset=UTF-8"
    }
  • Response body
    {
    "result": [{
    		"orderId": "251679538126441114",
    		"opType": "newInstance",
    		"remark": null,
    		"skuName": "telemarketing agent",
    		"modifyTime": 1679558854000,
    		"orderAmount": "36000",
    		"procutName": "monthly",
    		"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"
    }