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
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
On this page

Show all

API Overview

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

Table 1 describes the types and descriptions of dedicated gateway APIs.Table 2 describes the types and descriptions of the shared gateway APIs.

Table 1 Overview of dedicated gateway APIs

Type

Description

API Group Management

Create, modify, delete, and query API groups.

Environment Management

Create, modify, delete, and query environments.

Environment Variable Management

Create, modify, delete, query, and list environment variables.

Request Throttling Policy Management

Create, modify, delete, and query request throttling policies.

API Management

Create, modify, delete, publish, query, and debug APIs, take APIs offline, verify API definitions, and switch API versions.

Signature Key Management

Create, modify, delete, and query signature keys.

Binding/Unbinding Signature Keys

Bind and unbind signature keys, query signature keys bound to an API, and query APIs that are bound or not bound with a signature key.

Binding/Unbinding Request Throttling Policies

Bind and unbind request throttling policies, query APIs that are bound or not bound with a request throttling policy, and query request throttling policies bound to an API.

Excluded Request Throttling Configuration

Create, modify, delete, and query excluded request throttling configurations.

App Authorization Management

Authorize apps, cancel authorizations, query APIs that are bound or not bound with an app, and query apps bound to an API.

Resource Query

Query the quantities of APIs, API groups, and apps.

Domain Name Management

Bind, modify, and unbind domain names; bind, delete, and query domain name certificates.

Access Control Policy Management

Create, modify, delete, and query access control policies.

Binding/Unbinding Access Control Policies

Bind and unbind access control policies, query APIs that are bound or not bound with an access control policy, and query access control policies bound to an API.

Custom Authorizer Management

Create, modify, delete, and query custom authorizers.

API Import and Export

Import and export APIs.

VPC Channel Management

Includes:

  • Create, update, delete, and query VPC channels.
  • Add, query, and delete backend servers.
  • Enabling/Disabling backend servers.
  • Modify health check configuration of a VPC channel.
  • Add, update, delete, and view backend server groups, and query backend server group list of a VPC channel.

Monitoring Information Query

Query API calls within a specific period and query API calls under an API group in the last one hour.

Group Response Management

Create, query, modify, and delete group responses; query, modify, and delete responses of an error type.

Tag Management

Query tags.

Gateway Feature Management

Configure and query gateway features.

Configuration Management

Query resource configurations of a gateway and query gateway configurations.

Gateway Management

Includes:

  • Create, update, query, and delete dedicated gateways.
  • Bind and unbind EIPs.
  • Enable or disable public access for dedicated gateways, and update the outbound access bandwidth of dedicated gateways.
  • Query AZs.
  • Modify specifications.
  • Query gateway constraints.

VPC Endpoint Management

Includes:

  • Query the VPC endpoint connections of a gateway.
  • Query the whitelist records of a gateway's VPC endpoint service.
  • Accept or reject a VPC endpoint connection for a gateway.
  • Add whitelist records in batches for or delete those of a gateway's VPC endpoint service.

Gateway Tag Management

Add, delete, and query gateway tags.

Microservice Center Management

Import microservices.

SSL Certificate Management

Includes:

  • Create, delete, modify, and view a certificate, and query all SSL certificates.
  • Bind or unbind a domain name's SSL certificates.
  • Bind an SSL certificate to or unbind it from a domain name.
  • Obtain domain names bound to an SSL certificate.

Plug-in Management

Includes:

  • Create, modify, delete, and view a plug-in, and query all plug-ins.
  • Bind a plug-in to or unbind it from APIs.
  • Bind or unbind an API's plug-ins.
  • Query APIs bound with a plug-in or query plug-ins bound to an API.
  • Query APIs to which a plug-in can be bound or query plug-ins that can be bound to an API.

Credential Management

Includes:

  • Create, modify, delete, verify, and query apps, and reset AppKeys.
  • Create, automatically generate, delete, and query AppCodes.
  • Query the quotas of a credential.
  • Configure and delete access control settings of an app, and query access control details of an app.

Credential Quota Management

Includes:

  • Create, modify, and delete a credential quota.
  • Query credential quota details and all credential quotas.
  • Bind a credential quota to a credential, or unbind a quota from a specified credential.
  • Query credentials bound or not bound with a specified quota.

Asynchronous Task Management

Includes:

  • Import or export APIs asynchronously.
  • Query the result of an asynchronous task.

Orchestration Rule Management

Includes:

  • Create, view, update, and delete orchestration rules, and query orchestration rule details.
  • Query APIs to which an orchestration rule is bound.

Gateway Custom Inbound Port Management

Includes:

  • Add or delete a custom inbound port.
  • Query custom inbound ports of a gateway.
  • Query the domain names bound to a custom inbound port.
Table 2 Overview of shared gateway APIs (for existing users)

Type

Description

API Group Management

Create, modify, delete, and query API groups.

API Management

Create, modify, delete, publish, and query APIs, and take APIs offline.

App Management

Create, modify, delete, and query apps, and reset AppSecrets.

App Authorization Management

Authorize apps and cancel and query authorizations.

Environment Management

Create, modify, delete, and query environments.

Environment Variable Management

Create, delete, and query environment variables.

Request Throttling Policy Management

Create, modify, delete, and query request throttling policies.

Binding/Unbinding Request Throttling Policies

Query, bind, and unbind request throttling policies.

Excluded Request Throttling Configuration

Create, modify, delete, and query excluded request throttling configurations.

Access Control Policy Management

Create, modify, delete, and query blacklists and whitelists.

Binding Access Control Policies

Query access control policies bound to an API and APIs that are bound or not bound to an access control policy; unbind an API from an access control policy.

Querying Subscription Information in KooGallery

Query purchased API groups, API group details, and APIs.

Configuration Management

Configure object models and query configuration details.

Resource Query

Query the numbers of API groups, APIs, and apps.

Signature Key Management

Create, modify, delete, and query signature keys.

Binding/Unbinding Signature Keys

Bind and unbind signature keys; query APIs that are bound or not bound to a signature key; query signature keys bound to an API.

Domain Name Management

Bind and unbind domain names; bind and delete certificates.

VPC Channel Management

Create, update, delete, and query VPC channels; add, delete, and query cloud servers.

Monitoring Information Query

Query the number of times an API or APIs in an API group are called.

API Import and Export

Export Swagger definitions of APIs published in a specific environment.

Custom Authorizer Management

Create, modify, delete, and query custom authorizers.

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