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

Trigger Management Models

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

This section describes the returned fields of the trigger management models.

Trigger Type Model

{ 
    "trigger_type_code":"string", 
    "display_name":"string", 
    "status":"string", 
    "event_codes":"array of string", 
    "description":"string" 
}

Table 1 describes the parameters in the trigger type model.

Table 1 Parameters in the trigger type model

Parameter

Description

trigger_type_code

Trigger type code. Options: SMN, APIG, timer, DMS, DIS, LTS, DDS, CTS, APIG (dedicated), APIC, and Kafka.

display_name

Trigger type name.

status

Trigger type status. Options:

  • DISABLED: The trigger is disabled.
  • TEST: The trigger is under test and invisible to clients.
  • ACTIVE: The trigger is available.

event_codes

Event attribute field.

description

Trigger description.

Trigger Instance Model

{ 
    "trigger_id":"string",
    "trigger_type_code":"string",
    "event_type_code":"string",
    "status":"string",
    "event_data":"json struct",
    "last_updated_time":"string",
    "created_time":"string" 
}

Table 2 describes the parameters in the trigger instance model.

Table 2 Parameters in the trigger instance model

Parameter

Description

trigger_id

Trigger ID.

trigger_type_code

Trigger type code. Options: SMN, APIG, TIMER, DMS, DIS, LTS, DDS, CTS, and kafka.

event_type_code

Event type code. This parameter is mandatory. It can be a non-null character string. This parameter is not used currently.

status

Trigger status. Options: ACTIVE and DISABLED.

event_data

Trigger data defined in JSON format.

last_updated_time

Time when the trigger was last updated.

created_time

Time when the trigger was created.

Trigger Instance Data

  • The data of a Simple Message Notification (SMN) trigger is as follows:
    { 
        "topic_urn":"string", 
        "subscription_status":"string" 
    } 

    Table 3 describes the parameters of an SMN trigger.

    Table 3 Parameters of an SMN trigger

    Parameter

    Description

    topic_urn

    URN of an SMN topic. This parameter is mandatory when you create an SMN trigger.

    subscription_status

    Subscription status of a topic. Options: Unconfirmed and Confirmed.

  • The data of a Distributed Message Service (DMS) trigger is as follows:
    { 
        "queue_id":"string", 
        "consumer_group_id":"string", 
        "polling_interval":"int" 
    }

    Table 4 describes the parameters of a DMS trigger.

    Table 4 Parameters of a DMS trigger

    Parameter

    Description

    queue_id

    Name of a DMS queue. This parameter is mandatory when you create a DMS trigger.

    consumer_group_id

    Name of a DMS consumer group. This parameter is mandatory when you create a DMS trigger.

    polling_interval

    Interval at which messages are polled. This parameter is mandatory when you create a DMS trigger. Default value: 30s.

  • The data of a Data Ingestion Service (DIS) trigger is as follows:
    {
    "stream_name": "dis-qYPJ",
    "polling_interval": 30,
    "batch_size": 100,
    "sharditerator_type": "TRIM_HORIZON"
    }

    Table 5 describes the parameters of a DIS trigger.

    Table 5 Parameters of a DIS trigger

    Parameter

    Description

    stream_name

    Name of a stream. This parameter is mandatory.

    polling_interval

    Pull period. This parameter is optional. Value range: 1–60. Default value: 30.

    batch_size

    Number of data records that can be pulled from a specified stream. This parameter is optional. Value range: 1–10000. Default value: 100.

    sharditerator_type

    Options: TRIM_HORIZON (pulling data from the beginning of a stream) and LATEST (pulling data from the current position). This parameter is mandatory.

  • The data of an APIG trigger is as follows:
    { 
        "group_id":"string", 
        "env_id":"string", 
        "auth":"string", 
        "protocol":"string", 
        "name":"string", 
        "path":"string", 
        "match_mode":"string",  
        "req_method":"string" , 
        "backend_type":"string" , 
        "type": int , 
        "sl_domain":"string" , 
        "instance_id":"string" 
    }

    Table 6 describes the parameters of an APIG trigger.

    Table 6 Parameters of an APIG trigger

    Parameter

    Description

    group_id

    API group. This parameter is mandatory.

    env_id

    API publishing environment. This parameter is mandatory.

    auth

    API authentication mode. Options: NONE, IAM, and APP. This parameter is mandatory.

    protocol

    Access protocol. Options: HTTP and HTTPS. This parameter is mandatory.

    name

    API name. This parameter is mandatory.

    path

    API access address, which must meet the URL rules, for example, /a/b. This parameter is mandatory.

    match_mode

    Match mode. Currently, only the prefix match mode (corresponding to SWA) is supported. This parameter is mandatory.

    req_method

    API request method, which is of enumerated type. Options: GET, POST, and PUT. This parameter is mandatory.

    backend_type

    Backend type, which must be set to FUNCTION. This parameter is mandatory.

    type

    API type. Currently, only 1 is supported, indicating open API. This parameter is mandatory.

    sl_domain

    Subdomain name. This parameter is mandatory.

    instance_id

    Instance ID. This parameter is mandatory when trigger_type_code is set to DEDICATEDGATEWAY or APIC.

  • The data of a timer trigger is as follows:
    {
    	"name": "string",
    	"schedule_type": "string",
    	"schedule": "string",
    	"user_event": "string"
    }

    Table 7 describes the parameters of a timer trigger.

    Table 7 Parameters of a timer trigger

    Parameter

    Description

    name

    Trigger name. This parameter is mandatory.

    schedule_type

    Schedule type. Options: Rate or Cron. This parameter is mandatory.

    schedule

    Schedule setting, which varies depending on the schedule type you choose. This parameter is mandatory.

    When schedule_type is set to Rate, add unit m, h, or d behind a rate, for example, 3m for 3 minutes.

    user_event

    Additional information for calling a function. This parameter is optional.

  • The data of a DDS trigger is as follows:
    {
    	"instance_id": "string",
            "collection_name": "string",
            "db_name": "string",
    	"db_password": string,
            "batch_size": int,
    }
    Table 8 Parameters of a DDS trigger

    Parameter

    Description

    instance_id

    DB instance ID.

    collection_name

    Collection name.

    db_name

    Database name.

    db_password

    Password for logging in to the database.

    batch_size

    Batch size.

  • The data of a Kafka trigger is as follows:
    {
            "instance_id": "string",
    	"topic_id": "[]string",
            "kafka_user": "string",
            "kafka_password": "string",
    "kafka_ssl_enable": string,
            "batch_size": int,
    }
    Table 9 Parameters of a Kafka trigger

    Parameter

    Description

    instance_id

    Kafka instance ID.

    topic_id

    Topic ID.

    kafka_user

    Username.

    kafka_password

    User password.

    kafka_ssl_enable

    Whether to enable SSL authentication. If SSL authentication is enabled, the kafka_user and kafka_password fields are mandatory.

    batch_size

    Batch size.

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