Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Interface Description

Updated on 2025-01-17 GMT+08:00

Before releasing a SaaS product to KooGallery, develop a production interface on your server by referring to this access guide.

The following table lists the SaaS 2.0 interface specifications.

Scenario

SaaS

One-Time Payment

Yearly/Monthly

Pay-per-Use

Creating an instance

Mandatory

Mandatory

Mandatory

Querying instance information

Mandatory

Mandatory

Mandatory

Updating an instance

N/A

Mandatory

Mandatory

Updating the instance status

N/A

Mandatory

Mandatory

Releasing an instance

Mandatory

Mandatory

Mandatory

Upgrading an instance

N/A

Optional

N/A

NOTE:

When releasing a product, develop interfaces based on the delivery method and billing mode as listed in the preceding table.

If a product can be upgraded, implement the interface for instance upgrade.

Example: https://www.isvwebsite.com/saasproduce

SaaS 2.0 Instance Dialing Test Rules

After SaaS product release, KooGallery conducts interface address dialing tests every morning and afternoon to monitor the availability for order placement. If a dialing test fails, the system sends a notification to the email address or mobile number bound to your account or as a direct message. Rectify the interface promptly. The following table lists the dialing test rules.

Product Status

Dialing Test

On sale

Required

Discontinued

Skipped

Withdrawn from KooGallery

Skipped

If the dialing test of an interface fails for five consecutive days, the KooGallery operations manager freezes the product transaction and hides the product from customers. According to the Huawei Cloud KooGallery Partner Product Seller Agreement, if the fault is not rectified in time, KooGallery has the right to remove the product from the catalog.

Interface Calling Scenario (Order Placement)

  • Instance creation: A customer purchases and pays for a product.
    1. KooGallery calls the instance creation interface to ask you to create an instance based on the order ID.
    2. After receiving the request, your system calls the KooGallery API for querying an order to obtain the subscription information and subscribe to the instance.
    3. KooGallery calls the instance query interface to obtain instance information.
  • Instance query: A customer queries information about an instance (instanceId).
    1. After obtaining the instance ID (instanceId) returned by the instance creation interface, KooGallery continuously calls the instance query interface until you successfully return the instance information.
    2. When a customer queries resource information in KooGallery, KooGallery synchronously calls the instance query interface and returns the information.
  • Instance update: A customer changes trial use to commercial use, renews resources, or cancels renewals.

    KooGallery calls the instance update interface to notify your system of the resource expiration time. Your system performs the corresponding action and returns the execution result to KooGallery.

  • Instance status update: If an instance of a customer expires or the customer violates regulations, the instance will be frozen. After the instance is renewed or the violation is canceled, the instance will be unfrozen.

    KooGallery calls the instance status update interface to ask your system to freeze or unfreeze the corresponding resource and return the execution result to KooGallery.

    NOTE:

    When a purchased product expires, the retention period starts. The retention period varies with the customer tier and can be up to 15 days long. During the retention period, the product is frozen and cannot be used. The customer can continue using the product after renewal. Therefore, you need to set a retention period to no less than 15 days for your SaaS products and retain customer data during the retention period.

  • Instance release: A customer releases an instance of a purchased product (in scenarios such as no renewal upon expiration and unsubscription).
    1. KooGallery calls the instance release interface to ask your system to release the corresponding resource and return the execution result to KooGallery.
  • Instance upgrade: A customer upgrades purchased resources and pays for the upgrade order.
    1. KooGallery calls the instance upgrade interface to ask your system to upgrade the corresponding resource.
    2. Your system calls the KooGallery API for querying an order to obtain the upgrade information, upgrades the instance, and returns the execution result to KooGallery.

    For details about the instance upgrade process, see Upgrade and Billing Rules.

  • Tenant synchronization
    1. After a customer purchases a joint operations SaaS, logs in to Huawei Cloud console, and binds the app with their enterprise, KooGallery calls this interface to ask you to synchronize the tenant information of the enterprise, save the tenant information, and return the result to KooGallery.
    2. If the interface fails to be called, the customer can retry calling. You will be notified of the calling failure via SMS message or email.
    3. When processing an interface request, your server must ensure idempotency.

      For the same instance under a tenant, your server must support multiple requests for adding or deleting the instance. For subsequent additions, no new data should be generated and a success message must be returned. For deletions, you do not need to verify whether the instance generated after the instance creation interface is called exists, but you should return a success message after each deletion.

  • App synchronization
    1. After a customer purchases a joint operations SaaS, logs in to Huawei Cloud console, and binds the app with their enterprise, KooGallery calls this interface to ask you to synchronize the authentication information of the app, save the app information, and return the result to KooGallery.
    2. If the interface fails to be called, the customer can retry calling. You will be notified of the calling failure via SMS message or email.
    3. When processing an interface request, your server must ensure idempotency.

      For the same instance of the same app under a tenant, your server must support multiple requests for adding or deleting the instance. For subsequent additions, no new data should be generated and a success message must be returned. For deletions, you do not need to verify whether the instance generated after the instance creation interface is called exists, but you should return a success message after each deletion.

  • App authorization
    1. After an administrator is authorized to manage an enterprise, logs in to Huawei Cloud console, and authorizes users in the enterprise to use apps bound to the enterprise, KooGallery asynchronously calls this interface to ask you to synchronize the user authorization information of the apps, save the information, and return the result to KooGallery.
    2. If the interface fails to be called, the administrator can retry synchronization. You will be notified of the calling failure via SMS message or email.
    3. When processing an interface request, your server must ensure idempotency.

      For the same instance of the same app and userName under a tenant, your server must support multiple requests for adding or deleting the instance. For subsequent additions, no new data should be generated and a success message must be returned. For deletions, you do not need to verify whether the instance generated after the instance creation interface is called exists, but you should return a success message after each deletion.

  • Organization synchronization (incremental)
    1. After an administrator is authorized to manage an enterprise, logs in to Huawei Cloud console, and creates, edits, or deletes departments for the enterprise, KooGallery calls this interface to ask you to synchronize organization changes, save the organization information, and return the result to KooGallery.
    2. When processing an interface request, your server must ensure idempotency.

      For the same instance of the same orgCode under a tenant, your server must support multiple requests for adding or deleting the instance. For subsequent additions, no new data should be generated and a success message must be returned. For deletion, you do not need to verify whether the instance generated after the instance creation interface is called exists, but you should return a success message after each deletion.

  • Organization synchronization (full)
    1. After a customer purchases a joint operations SaaS, logs in to Huawei Cloud console, and binds the app with their enterprise, KooGallery calls this interface to ask you to synchronize all organization information of the enterprise, save the organization information, and return the result to KooGallery.
    2. When processing an interface request, your server must ensure idempotency.

      For the same instance of the same orgCode under a tenant, your server must support multiple requests. No new data should be generated and a success message must be returned.

Interface Failure Scenarios and Retry Mechanism

If an interface fails to respond, the system sends an email to the email address bound to your KooGallery account. You can query the exception information on the Service Interface Messages page of the Seller Console. Handle the exceptions as soon as possible to avoid unsubscription due to order failure.

  • When the instance creation interface fails to be called, KooGallery retries for 3 hours. You can click Restart in the Operation column on the right of the order on the Service Interface Messages page to retry calling. If the interface exception persists after 3 hours, the system determines that the order fails and cancels the order.
  • When the instance update interface fails to be called, KooGallery retries for an hour. You can query the exception information on the Service Interface Messages page. After rectifying the exception, click Restart in the Operation column on the right of the order on the Service Interface Messages page to retry calling.
  • When the instance status update interface fails to be called, KooGallery retries for an hour. You can query the exception information on the Service Interface Messages page. After rectifying the exception, click Restart in the Operation column on the right of the order on the Service Interface Messages page to retry calling.
  • When the instance upgrade interface fails to be called, KooGallery retries for 3 hours. You can click Restart in the Operation column on the right of the order on the Service Interface Messages page to retry calling. If the interface exception persists after 3 hours, the system determines that the order fails and cancels the order.
    NOTE:

    If an interface fails to respond, an email, SMS message, or direct message will be sent to you. Check the email address and mobile number bound to your account and the Message Center on Huawei Cloud.

    If more than five orders of a product failed in a month due to interface failures or an interface fails the dialing test for five consecutive days, KooGallery will remove the product from the catalog.

    If an order is automatically canceled due to an interface failure, contact the customer at the earliest to handle the problem.

    If a customer can still use expired resources due to an interface failure, you shall bear the resource loss incurred.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback