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

Expiration

Description

  • KooGallery invokes this interface when a purchased product expires. After receiving an expiration notification, you must freeze the purchased product.
  • If the expiration interface fails to be called, KooGallery will retry to call it 60 times (once every minute). You can view the interface exception information on the Application Tools > Service Interface Messages page. If the interface exception is resolved, the next call will be successful. Otherwise, KooGallery stops calling the interface. After the exception is solved, go to the Seller Console, locate the order on the Application Tools > Service Interface Messages page, and click Restart Debugging in the Operation column in the same row to call the interface again.
    • Check the email address bound to your Huawei Cloud account. If you receive an email about an interface calling failure, resolve the exception as soon as possible.
    • KooGallery monitors interface exceptions. If freezing a SaaS product frequently fails due to interface 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: GET

Parameter

Mandatory

Type

Maximum Length of Characters

Description

activity

Yes

String

20

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

For product expiration, the value is expireInstance.

instanceId

Yes

String

64

Instance ID.

orderId

Yes

String

64

Same as the ID of the subscription order.

testFlag

No

String

2

Whether a request is submitted for debugging.

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

The default value is 0.

authToken

Yes

String

50

Security verification token.

For the values, see authToken Value.

timeStamp

Yes

String

20

Time (UTC time) when a request is initiated.

Format: yyyyMMddHHmmssSSS

Example request:

https://isvserver.com/produceAPI?activity=expireInstance&instanceId=03pf80c2bae96vc49b80b917bea776d7 &timeStamp=20170725025113409&testFlag=0&authToken=09lsS5y+KCtxBu+ON4TXv1SrjH5KVYka9sx2MauHrQU=

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.
  • When processing an interface request, the ISV server must ensure idempotence.
  • KooGallery may resend requests for a single order. When receiving a duplicate order with the same instanceId value, the ISV server needs to return a success response, rather than freeze the instance again.

Example response:

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

Parent topic: Interface Description