El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.

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
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

OpenAPI

Updated on 2023-12-28 GMT+08:00

The OpenAPI connector is used to generate and release an API. The API is implemented by the subsequent components of the OpenAPI component. Therefore, the OpenAPI component can be used only as the trigger in a composite application and must be followed by other nodes.

After a flow is started, you can choose API Connect > APIs to view and edit the released API.

Action

Receiving API calls

Configuration Parameters

Parameter

Description

Name

Enter an API name. The name will be displayed on the APIs page of the corresponding ROMA Connect instance.

Security Authentication

Select a security authentication mode. Options:

  • App: ROMA Connect authenticates API requests. When calling an API, a user gets authenticated using the key and secret of an authorized integration application. APIs using this mode can be called by all users.
  • IAM: IAM authenticates API requests. When calling an API, a user gets authenticated using a token or an AK/SK pair. APIs using this mode can be called only by users on the same cloud service platform.
  • None: Authentication is not required for API requests. APIs using this mode are less secure and can be called by all users. Be careful when using this mode.

Request Method

Select a request method of the API.

Request Path

Enter the API request path.

Matching

Select a matching mode of the API request path.

  • Exact match: The path in an API request must be the same as the value of Request Path.
  • Prefix match: The path in an API request must be prefixed with the value of Request Path. For example, if Request Path is set to /test/AA and Matching is set to Prefix match, the API can be accessed using /test/AA/BB or /test/AA/CC but cannot be accessed using /test/AACC.

Request Parameter

Configure the request parameters of the API. Click Add to define API request parameters as required.

  • Name: name the request parameter
  • Type: Select the type of the request parameter. The options are Header and Query. If the request path contains the Path parameter, the Path parameter is required.
  • Mandatory: Whether the request parameter is mandatory in an API request.
  • Default Value: Available when Mandatory is set to No If no value is assigned to this parameter when the API is called, the default value is used.
NOTE:

Request parameters can be referenced as custom variables in subsequent nodes. For details, see Custom Variables.

Example Body

Available when Request Method is set to POST or PUT.

Example request body of an API

NOTE:

The request body can be referenced as node variables in subsequent nodes. For details, see Node Variables.

Response Mode

Select a response mode of the API.

  • Synchronous: After receiving a request, the API processes the request immediately and returns a result.
  • Asynchronous: After receiving a request, the API returns a response body, queues the request, and returns a result after the request is successfully processed.

Response Body

Available when Response Mode is set to Asynchronous.

Response body returned after the API receives a request.

Utilizamos cookies para mejorar nuestro sitio y tu experiencia. Al continuar navegando en nuestro sitio, tú aceptas nuestra política de cookies. Descubre más

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback