Help Center/ KooGallery/ Access Guide/ SaaS Access Guide V1.0 (Existing Products)/ Interface Description/ Resource Status Change
Updated on 2023-09-22 GMT+08:00
View PDF
Share

Resource Status Change

Description

After a customer purchases a pay-per-use product (or package), when the instance expires or the customer violates regulations, KooGallery calls this interface to freeze the instance.

  • If you receive an email indicating that the interface fails to be called in your email address of customer service or that one bound to your KooGallery account, handle the exception in a timely manner.
  • KooGallery monitors interface exceptions. If a product has frequent interface exceptions, KooGallery will remove the product from the catalog.

The following figure shows the process of changing the resource status.

Request Message

The following table describes the request parameters.

Request method: GET

Parameter

Mandatory

Type

Maximum Length of Characters

Description

authToken

Yes

String

50

Security verification token.

For details about the value, see authToken Value.

activity

Yes

String

32

Interface request ID, which is used to distinguish interface request scenarios.

For resource status changes, the value is instanceStatus.

instanceId

Yes

String

64

Instance ID.

CAUTION:

Use the instance ID returned by the pay-per-use billing interface.

instanceStatus

Yes

String

32

New status.

  • FREEZE: frozen.
  • NORMAL: unfrozen

timeStamp

Yes

String

20

Time (UTC time) when a request is initiated.

Format: yyyyMMddHHmmssSSS

testFlag

No

String

2

Whether a request is submitted for debugging.

  • 1: debugging request.
  • 0: non-debugging request.

The default value is 0.
Example request: 
Freezing an instance: https://example.isv.com?activity=instanceStatus&instanceId=huaweitest123456&instanceStatus=FREEZE&testFlag=1&timeStamp=20230327070251713&authToken=pqlrW7%2BPHC%2F1JE%2BMEjKxC94GGJreoS6PZHd982auw2o%3D
Unfreezing an instance: https://example.isv.com?activity=instanceStatus&instanceId=huaweitest123456&instanceStatus=NORMAL&testFlag=1&timeStamp=20230327070251713&authToken=pqlrW7%2BPHC%2F1JE%2BMEjKxC94GGJreoS6PZHd982auw2o%3D

Response Message

The following table describes the response parameters.

Parameter

Mandatory

Type

Maximum Length of Characters

Description

resultCode

Yes

String

6

Invocation result code.

For details, see Invocation Result Codes.

resultMsg

No

String

255

Invocation result description.

Example response:

{
    "resultCode":"000000",
    "resultMsg":"success."
}
Parent topic: Interface Description