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
Help Center/ API Gateway/ Getting Started/ Quickly Opening and Calling APIs

Quickly Opening and Calling APIs

Updated on 2024-12-10 GMT+08:00

This section describes how to quickly get started with APIG. The following uses simple authentication with an app as an example to describe how to quickly open and call APIs.

Figure 1 Using APIG
  1. Preparations

    Before using APIG, ensure you have configured a VPC, subnet, and security group.

  2. Create a gateway

    Create a gateway with appropriate specifications.

  3. Open the API

    Create an API that supports simple authentication with Mock backend. Debug the created API and publish it.

  4. Call the API

    Create a credential and add an AppCode. Then use an API test tool to call the API with the AppCode.

Step 1: Preparations

  1. Register with Huawei Cloud and complete real-name authentication.

    If you already have a Huawei account, skip this step. If you do not have one, see Signing up for a HUAWEI ID and Enabling Huawei Cloud Services and Real-Name Authentication.

  2. Ensure that your account has sufficient balance before creating an APIG gateway.

    To top up your account, see Topping Up an Account.

  3. Before creating an APIG gateway, ensure that your account has permissions to perform operations on APIG gateways.

    You must be assigned both the APIG Administrator and VPC Administrator roles so that you can create gateways.

    Alternatively, you must be attached the APIG FullAccess policy.

    To achieve fine-grained management of your cloud resources, create IAM user groups and users and grant specified permissions to the users. For details, see Creating a User and Granting Permissions.

  4. Before creating an APIG gateway, ensure that a VPC and a subnet are available.

    Configure a VPC and subnet for the APIG gateway as required. You can use the current account's existing VPC and subnet or create new ones.

    For details about how to create a VPC and a subnet, see Creating a VPC. Note: The VPC must be created in the same region as the APIG gateway.

  5. Before creating an APIG gateway, ensure that a security group is available.

    Configure the security group for APIG gateways as required. You can use the current account's existing security groups, or create new ones. For details, see Creating a Security Group.

    To connect to APIG gateways, add the security group rules described in Table 1. Other rules can be added based on site requirements.
    Table 1 Security group rule

    Direction

    Protocol

    Port

    Source address

    Description

    Inbound

    TCP

    80/443

    0.0.0.0/0

    Intra-VPC Access

    NOTE:
    • After a security group is created, it has a default inbound rule that allows communication among ECSs within the security group and a default outbound rule that allows all outbound traffic. If you access your APIG gateway using the private network within a VPC, you do not need to add the rules described in Table 1.
    • ELB load balancing is enabled by default after gateways are created in regions except LA-Mexico City1 and CN North-Beijing1. Gateways with load balancing enabled do not support security groups. To disable access from specific IP addresses, see access control policy.
    • ELB functions as a load balancer for gateways, which support cross-VPC access. Gateways with public inbound access enabled are randomly assigned an EIP and cannot use an existing EIP.

Step 2: Create a gateway

  1. Go to the Buy Gateway page.
  2. Configure the gateway according to the following table.

    Table 2 Configuring the gateway

    Parameter

    Description

    Billing Mode

    Billing mode of the gateway. Select Pay-per-use.

    Region

    The region to which the gateway belongs. Select CN-Hong Kong.

    AZ

    The AZ of the gateway. Select AZ1, AZ2, and AZ3.

    Gateway Name

    Enter the gateway name, for example, apig-test.

    Edition

    Gateway specifications. Select Basic.

    Scheduled Maintenance

    The period for gateway maintenance. Retain the default value.

    Enterprise Project

    Select default.

    VPC

    Select the prepared VPC and subnet.

    Public Inbound Access

    Allows external services to call instance creation APIs using EIPs. Enable the public network entry.

    Security Group

    Select the prepared security group.

  3. Click Next.
  4. Confirm the configuration, read and confirm your acceptance of the service agreement, and click Pay Now.

Step 3: Open the API

  1. Create an API.

    1. In the navigation pane, choose API Management > APIs.
    2. Click Create API > Create API and configure the frontend.
      Table 3 Frontend definition

      Parameter

      Description

      API Name

      Enter the API name, for example, API_test.

      Group

      Select the default group DEFAULT. To create a group, click Create API Group. For details about how to create an API, see Creating an API Group.

      URL

      Method: Request method of the API. Set this parameter to GET.

      Protocol: Set this parameter to HTTPS.

      Subdomain Name: The subdomain automatically allocated to the API group. The subdomain name of the default API group is used.

      Path: path of the API request. Set this parameter to /test.

      Gateway Response

      The response to be displayed if APIG fails to process an API request. Default: default.

    3. Configure security settings based on the following table.
      Table 4 API request definition

      Parameter

      Description

      Authentication Mode

      API authentication mode. Set this parameter to App.

      Simple Authentication

      If you enable this option, API Gateway verifies only the AppCode and the request signature does not need to be verified. For this example, enable Simple Authentication.

    4. Click Next and configure the default backend information.
      Table 5 Parameters for defining a Mock backend service

      Parameter

      Description

      Backend Type

      Backend service type. Select Mock to prevent API requests from being forwarded to the backend service. This is useful if you need to debug APIs when the backend is unavailable. If a backend service is available, configure other backend service types as required. For details, see Creating an API.

      Status Code

      The HTTP status code returned by the API. Use the default 200 here.

      Response

      Expected result to the API caller for debugging and verification. Enter success here.

    5. Click Finish.

  2. Debug the API.

    1. On the APIs tab page, select an API and click Debug.
    2. Click Debug on the right of the URL. The API request and response information are displayed at the bottom of the page.

      If the API is successfully called, the status code 200 is displayed, and success is returned for the Mock backend. Otherwise, rectify the fault by referring to Error Codes.

  3. Publish the API.

    1. On the APIs tab, click Publish Latest Version.
    2. Select the environment in which the API is to be published. Select the default environment RELEASE. Or you can click Create Environment to create an environment. For details, see Environment Management.
    3. Click OK.

Step 4: Call the API

  1. Create a credential.

    1. In the navigation pane, choose API Management > Credentials.
    2. Click Create Credential and enter the credential name. In this example, enter apptest.
    3. Click OK.

  2. Bind the credential to the API. Note that only APIs that use app authentication can be bound.

    1. In the Operation column of the created credential, click Bind to APIs.
    2. Select an environment, API group, and APIs.
    3. Click OK.

  3. Add an AppCode.

    1. In the credential list, click the created credential to go to the credential details page.
    2. Under AppCodes, click Add AppCode.
    3. Select Automatically generated.
    4. Click OK.

  4. Call the API.

    Use the API test tool to configure the API request and authentication.

    1. Select GET as the request method. On the APIs page, copy the URL in the format of https://debugging domain name/path to the API test tool.
    2. Add the header parameter X-Apig-AppCode and set the parameter value to the generated AppCode.
    3. Send the request.

      If the API is successfully called, the status code 200 is displayed, and success is returned for the Mock backend. Otherwise, rectify the fault by referring to Error Codes.

Related Documents

  • For details about how to create an API, see Creating an API.
  • For details about how to call APIs, see Calling APIs.
  • If an API fails to be called, refer to Error Codes.
  • VPC owners can share the subnet in the VPC with one or multiple accounts through Resource Access Manager (RAM). Through VPC sharing, you can easily configure, operate, and manage multiple accounts' resources at low costs. For more information about VPC and subnet sharing, see VPC Sharing.

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