Help Center/ KooGallery/ Access Guide/ SaaS Product Access Guide/ APIs/ Releasing an Instance
Updated on 2023-09-01 GMT+08:00
View PDF

Releasing an Instance

Description

When an instance of a purchased product is released (for example, the instance is not renewed upon expiration or unsubscribed from), KooGallery calls this API to delete the instance.

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

The following figure shows the process of expiration.

Request Message

The following table describes the request parameters.

Request method: POST

Parameter

Mandatory

Type

Maximum Length

Description

activity

Yes

String

32

Request ID, which is used to distinguish the scenario.

For expiration, the value is releaseInstance.

instanceId

Yes

String

64

Instance ID.

orderId

No

String

64

If an instance is released due to unsubscription, the value of this parameter is the ID of the order to be cancelled.

orderLineId

No

String

64

KooGallery order line ID.

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:

curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=C4E5F264C92F737DEBECB***********80202B59027CEEFC4932&timestamp=1680509885590&nonce=A49E8F86EE5BCAFBDFD3E53F1E09A29C6D9E8DACC67382EBCDD02CD55CBBB7AE' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"releaseInstance","instanceId":"10e758d0**********-81d03469a10e","orderId":"CS22111********VS","orderLineId":"CS221118*******S-000001","testFlag":"0"}'

Response Message

The following table describes the response parameters.

Parameter

Mandatory

Type

Maximum Length

Description

resultCode

Yes

String

6

Invocation result code.

For details, see Result Codes.

resultMsg

No

String

255

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

Example response:

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