On this page

Show all

Help Center/ KooGallery/ Access Guide/ SaaS Product Access Guide/ APIs/ Upgrading an Instance

Upgrading an Instance

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

View PDF

API Description

A customer upgrades a purchased resource. After the upgrade order is paid, KooGallery calls this API to ask you to upgrade the resource and record the upgraded product data.

The following figure shows the process of upgrading a product.

Click to enlarge

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 upgrades, the value is upgradeInstance.
instanceId	Yes	String	64	Instance ID. NOTE: The upgrade does not change instanceId.
orderId	Yes	String	64	Upgrade order ID. NOTE: An order is generated for the upgrade.
orderLineId	Yes	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=9D49F9BF09D69F7A**********0E07AF95FEE9E5BEF5218DA407&timestamp=1680510876429&nonce=D8FE86FA6ABE90CA63A72B3256743D3D869648FE99A96354E635F032629F6C21' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"upgradeInstance","instanceId":"10e75*********b-81d03469a10e","orderId":"CS2*******4LVS","orderLineId":"CS221118*******-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.

Parameter

Mandatory

Type

Maximum Length

Description

resultCode

Yes

String

Invocation result code.

For details, see Result Codes.

resultMsg

String

255

Invocation result description.

Example response:

{ 
    "resultCode":"000000", 
    "resultMsg":"success." 
}

Parent topic: APIs

Previous topic: Releasing an Instance

Next topic: Result Codes

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel