Help Center > > API Reference> Transaction Management> Managing Resource Packages> Querying Resource Packages

Querying Resource Packages

Updated at: Dec 15, 2021 GMT+08:00

Function

This API is used to query resource packages.

Constraints

This API can be invoked only by the customer AK/SK or token.

If a resource package has expired for more than 18 months, its information cannot be queried.

URI

POST /v3/payments/free-resources/query

Table 1 Header parameter

Parameter

Mandatory

Value Range

Description

X-Language

Yes

A maximum of 8 characters

Language.

  • zh_CN: Chinese
  • en_US: English

Default value: zh_CN

Request

Request Parameters

Parameter

Mandatory

Type

Value Range

Description

region_code

No

String

A maximum of 64 characters

Cloud service region code, for example, cn-north-1. Obtain the value from the Region column in Regions and Endpoints.

order_id

No

String

A maximum of 64 characters

Order ID.

product_id

No

String

A maximum of 64 characters

Resource package ID.

product_name

No

String

A maximum of 256 characters

Resource package name.

enterprise_project_id

No

String

A maximum of 64 characters

Enterprise project ID.

status

No

Integer

(0, 4)

Status:

  • 0: Not effective
  • 1: In effect
  • 2: Used up
  • 3: Expired
  • 4: Unsubscribed

offset

No

Integer

(0, 999999)

Offset, starting from 0. The default value is 0.

NOTE:

This parameter is used for pagination. Retain its default value 0 if pagination is not required. offset indicates the offset relative to the first data record among all that meets the conditions configured. If you set offset to 1, the second and subsequent data records are returned.

For example, there are 10 data records, and if you set limit to 10 and offset to 1, the second to the tenth data records are returned.

limit

No

Integer

(1, 1000)

Number of records queried each time. The default value is 10.

Example Request

POST https://bss-intl.myhuaweicloud.com/v3/payments/free-resources/query HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "region_code": "cn-north-7",
    "order_id": "CS21043011259RWXXTA",
    "product_id": "90301-296014-0--0",
    "product_name": "HUAWEI CLOUD WeLink",
    "enterprise_project_id": null,
    "status": 1,
    "offset": 0,
    "limit": 10
}
  

Response

Response Parameters

Parameter

Type

Value Range

Description

error_code

String

20

Error code.

For details, see Returned Values. This parameter is returned only when the query failed.

error_msg

String

1000

Error description. This parameter is returned only when the query failed.

free_resource_packages

List<FreeResourcePackage>

-

Resource package list. For details, see Table 2.

total_count

Integer

-

Total number of records

Table 2 FreeResourcePackage

Parameter

Type

Value Range

Description

order_instance_id

String

A maximum of 64 characters

Identifier of a subscribed resource package.

order_id

String

A maximum of 64 characters

Order ID. If the value of source_type is 1, this parameter is left empty.

product_id

String

A maximum of 64 characters

Resource package ID.

product_name

String

A maximum of 256 characters

Resource package name.

enterprise_project_id

String

A maximum of 64 characters

Enterprise project ID.

enterprise_project_scope

Integer

(0, 1)

Enterprise projects for which resource packages are used:

  • 0: All enterprise projects
  • 1: Specific enterprise projects

effective_time

String

A maximum of 20 characters

Time when a resource package is purchased. The value is in UTC format.

expire_time

String

A maximum of 20 characters

Expiration time of a resource package. The value is in UTC format.

status

Integer

(0, 4)

Status:

  • 0: Not effective
  • 1: In effect
  • 2: Used up
  • 3: Expired
  • 4: Unsubscribed

service_type_code

String

A maximum of 64 characters

Cloud service type code. For example, the cloud service type code of OBS is hws.service.type.obs. To obtain a specific service type, call the API in Querying Cloud Service Types.

region_code

String

A maximum of 64 characters

Cloud service region code, for example, cn-north-1. Obtain the value from the Region column in Regions and Endpoints.

source_type

Integer

(0, 1)

Source of a resource package. The options are as follows:

  • 0: Order
  • 1: Gifted by DevCloud

bundle_type

String

[ATOMIC_PKG|BUNDLE_PKG]

Bundle binding type. The options are as follows:

  • ATOMIC_PKG: Atomic package
  • BUNDLE_PKG: Combined package

quota_reuse_mode

Integer

(1,2)

Use model. The options are as follows:

  • 1: Resettable

    Indicates that the purchased pay-per-use resource package can be reset at a specified period. For example, if you purchase a 1-year 40 GB pay-per-use resource package with quota_reuse_mode set to 1 and quota_reuse_cycle to 4, then the resource package will be reset each month (you will get 40 GB resource each month) within the year.

  • 2: Not resettable

    Indicates that the purchased resource package will not be reset. For example, if you purchase a 1-year 40 GB pay-per-use resource package with quota_reuse_mode set to 2, the resource package will not be reset, and you will get 40 GB resource within the year.

free_resources

List<FreeResource>

-

For details about resource items (ID-specific) in a resource package, see Table 3.

Table 3 FreeResource

Parameter

Type

Value Range

Description

free_resource_id

String

A maximum of 64 characters

Resource ID. A resource package contains multiple resources, and each resource has a usage type.

usage_type_name

String

A maximum of 1024 characters

Usage type name.

amount

String

A maximum of 32 characters

Remaining resource quota of a package whose quota_reuse_mode is Resettable, that is, the remaining resource quota in the current reset period.

original_amount

String

A maximum of 32 characters

Original resource quota of a package whose quota_reuse_mode is Resettable, that is, the total resource quota in each reset period.

measure_id

Integer

-

Measurement unit of the quota of a free resource package. You call the API in Querying Measurement Units to obtain the value.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 
{
    "total_count": 1,
    "free_resource_packages": [
        {
            "order_instance_id": "01154-228300268-0",
            "order_id": "CS21043011259RWXXTA",
            "product_id": "90301-296014-0--0",
            "product_name": "HUAWEI CLOUD WeLink",
            "enterprise_project_id": null,
            "enterprise_project_scope": 0,
            "effective_time": "2021-04-30T03:30:56Z",
            "expire_time": "2021-05-31T15:59:59Z",
            "status": 1,
            "service_type_code": "hws.service.type.cpts",
            "region_code": "cn-north-7",
            "source_type": 0,
            "bundle_type": "ATOMIC_PKG",
            "quota_reuse_mode": 2,
            "free_resources": [
                {
                    "free_resource_id": "d4463497-991b-439d-9ab6-23f9ed197fe9",
                    "usage_type_name": "Duration",
                    "amount": 100,
                    "original_amount": 100,
                    "measure_id": 34
                }
            ]
        }
    ]
}

Returned Values

HTTP Status Code

Error Code

Description

400

CBC.0100

Incorrect parameter.

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel