Updated on 2024-07-05 GMT+08:00
Querying the Amount of Unsubscription Orders

Querying the Amount of Unsubscription Orders

Function

A customer can query the resources and original orders of the unsubscription amount for an unsubscription order or degrade order on the partner sales platform.

Notes:

  • This API can be invoked using the AK/SK or token of the partner's customer.
  • After you invoke the API in Unsubscribing from Yearly/Monthly Resources (Old) to generate an unsubscription order ID, you can invoke this API to query the resources and amount of an unsubscription order. For example, after you invoke the API in Unsubscribing from Yearly/Monthly Resources (Old), you can invoke this API to query the original order ID and original subscription renewal order ID.
  • You can query original order IDs for only unsubscription orders generated after May 2018.

    This API is about to be brought offline. For details about how to query the amount of unsubscription orders, see Querying the Amount of Unsubscription Orders.

URI

GET /v1.0/{domain_id}/common/order-mgr/orders/refund-order

The following table describes the parameters.

Table 1 URI parameters

Parameter

Mandatory

Maximum Length of Characters

Description

domain_id

Yes

A maximum of 64 characters

Table 2 Request parameters

Parameter

Mandatory

Type

Maximum Length of Characters

Description

order_id

Yes

String

A maximum of 64 characters

ID of an unsubscription or degrade order.

Request

Request Parameters

None

Example Request

GET https://bss-intl.myhuaweicloud.com/v1.0/{domain_id}/common/order-mgr/orders/refund-order?order_id=CS1*****GT HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

Response

Response Parameters

Parameter

Mandatory

Type

Description

error_code

Yes

String

Error code.

For details, see Status Code.

error_msg

Yes

String

Error description.

total_count

No

Integer

Total number of queries.

resource_info_list

No

List<ResourceInfo>

Resource list.

For details, see Table 3.

Table 3 ResourceInfo

Parameter

Mandatory

Type

Description

id

Yes

String

Record ID.

resource_id

No

String

Resource ID.

If the resource does not have an ID, this field is left empty.

Currently, this field is reserved and no value is returned.

amount

Yes

BigDecimal

Amount.

  • A negative number indicates the unsubscription amount.
  • A positive amount indicates the consumption amount or the unsubscription handling fee.

measure_id

Yes

String

Measurement unit.

  • 1: Dollar
  • 2: Dime
  • 3: Cent

customer_id

Yes

String

Customer ID.

resourceType

Yes

String

Resource type code. For example, the VM resource type code of ECS is hws.resource.type.vm. To obtain a specific resource type, call the API in Querying Resource Types.

cloudServiceType

Yes

String

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.

regionCode

Yes

String

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

preOrderId

No

String

ID of the original order corresponding to the unsubscription amount, consumption amount, or unsubscription handling fee.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  

{
    "error_code": "CBC.0000",
    "error_msg": "success",
    "total_count": 3,
    "resource_info_list": [
        {
            "id": "0b8**c**f3",
            "amount": -288,
            "resourceType": "hws.resource.type.volume",
            "cloudServiceType": "hws.service.type.ebs",
            "regionCode": "cn-north-1",
            "preOrderId": "CS1806201614MS037",
            "resource_id": null,
            "measure_id": "3",
            "customer_id": "f8*****231d"
        },
        {
            "id": "2ba*****2a9",
            "amount": 28,
            "resourceType": "hws.resource.type.volume",
            "cloudServiceType": "hws.service.type.ebs",
            "regionCode": "cn-north-1",
            "preOrderId": "CS18062016100U54J",
            "resource_id": null,
            "measure_id": "3",
            "customer_id": "f80*****31d"
        },
        {
            "id": "abe3*****5312",
            "amount": -260,
            "resourceType": "hws.resource.type.volume",
            "cloudServiceType": "hws.service.type.ebs",
            "regionCode": "cn-north-1",
            "preOrderId": "CS18062016100U54J",
            "resource_id": null,
            "measure_id": "3",
            "customer_id": "f80*****31d"
        }
    ]
}

Status Code

  • 4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
  • 5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.

HTTP Status Code

Error Code

Description

200

CBC.0000

Succeeded.

500

CBC.0999

Other errors.

400

CBC.0100

Incorrect parameter.

403

CBC.0151

Access denied.

200

CBC.5026

The order is not a degrade or unsubscription order.