LogoLogo
Our ServiceOther service
English
English
  • 🇬🇧VNG Cloud Help Center
  • Overview
    • About VNG Cloud
    • Product Updates (All)
      • 2024
  • vServer
    • Compute
      • What is vServer?
      • Announcements and updates
        • 2024
        • 2023
      • Getting started
        • UserData
      • Quota Limit
      • Instance
        • Connect to virtual server
          • Connecting a Windows Server by Remote Desktop (RDP)
          • Connecting to a Linux server by SSH Client
        • Flavor
        • Instance Lifecycle
        • Create an instance by using the wizard
        • Resize Instance
        • Restart Instance
        • Compute Encryption Volume
          • Using Compute Encryption Volume
      • Placement Group
      • Image
      • Network
        • Virtual Private Cloud (VPC)
        • DHCP Options Sets
          • DNS Server IP Address
        • Instance IP Address
        • Floating IP
        • External Interface
        • Virtual IP
        • Route Table
        • Peering
        • Test Internet Speed
        • Network ACL
        • Bandwidth
          • Package Bandwidth VNG Dedicated
          • Package Bandwidth Pay As You Go
          • Package Bandwidth Share
          • Package Bandwidth Dedicated
          • Payment Methods
      • Interconnect
        • Starts with Interconnect
        • Interconnect Features
        • Location connect and Bandwidth
        • Multicloud-Connection
        • Connections
          • Create a Dedicated Connection
          • View connection information
          • Update Connection
          • Delete Connection
        • UseCase
          • Multicloud Interconnect
          • Hybrid Interconnect
          • VPN Interconnect
          • Using a combination of Interconnect connection methods
      • Volume
        • Extend volume with Linux OS
        • Extend Volume with Windows OS
        • Volume Types
        • Check the IOPS performance
        • Convert Volume Type
      • Snapshot
        • Activate Snapshot
        • Create Snapshots
        • View Snapshot Information
        • Roll back VM by using a snapshot
        • Roll back a disk by using a snapshot
        • Delete Snapshot
        • How to calculate a Snapshot Service Charges
        • Disable Snapshot Service
        • UseCase Snapshot
          • Disaster Recovery
          • Develop and testing
          • Backup and restore the system periodically
          • Migrate data and applications between environments
          • Resist attacks from Hackers or malware infections
        • Share Snapshots
      • Security
        • SSH Key (Key pairs)
        • Security Groups
      • vBackup
        • Create backups for VM with policy
        • Create backups immediately (Back now)
        • Automatic Backup
        • Changing the backup policy
        • Restore Backup
        • Delete Backup
        • Backup Policies
          • Create, edit, delete backup policies
          • Schedule Structure of the Policy
      • Load Balancer
        • Deployment mode
        • Feature Comparison
        • Application Load Balancer
          • How it works (ALB)
          • Getting Started
          • Manage Load balancer
          • Listener
            • Add a HTTP listener
            • Add a HTTPS listener
            • Update & Delete a Listener
            • Listener Policies
            • Client Certificate Authentication
            • Config IP whitelist to load balancer
            • Config timeout
          • Certificate
            • Upload a certificate
          • Pool
            • Add & Update a Pool
            • Pool Members
              • Attach pool members
            • Config health check setting
            • Enable sticky session
            • Enable TLS encryption
            • Pool's algorithm
        • Network Load Balancer
          • How it works (NLB)
          • Getting Started (NLB)
          • Manage Load Balancer (NLB)
          • Listener (NLB)
            • Add a TCP Listener
            • Add a UDP Listener
            • Update & Delete Listener (NLB)
            • Config IP whitelist to load balancer
            • Config timeout
          • Pool
            • Add & Update a Pool
            • Pool Members
              • Attach pool members
            • Config health check setting (NLB)
            • Pool's algorithm
          • Common use cases
            • Config protocol Proxy with member Nginx
        • Monitor your load balancers
          • Metrics
          • Logs
        • Security
      • APIs & IaC
      • Terraform
        • Install Terraform
        • Manage vServer with Terraform
        • Manage vLB with Terraform
        • Reference Document
        • Argument Intergration with Terraform
      • Identity and Access Management (IAM) for vServer
        • Actions, resources, and required conditions for vServer Access Decentralization
        • Use Cases IAM
      • Pricing
    • vMarketplace
      • Third-party integration
      • Application Software Installation
        • Create & Install App
      • Network Software Installation
        • Juniper vSRX on HCM03
          • Create Juniper vSRX
          • Routing IP Range within VPC
        • Pfsense on HCM03
          • Create Pfsense App
          • Routing IP Range within VPC
          • VPN Client to Server
          • VPN Site to Site
            • Pfsense - AWS Cloud
          • Troublehooting - Disconnect network
          • Notice & Limitation
          • MTU & “DF flag” best practice on VNG Cloud
  • vStorage
    • Object storage
      • Object storage (HCM03, HAN01)
        • What is vStorage?
          • What is Region?
          • What is Farm?
          • Unit of Measurement
        • Announcements and Updates
        • Getting Started with vStorage
          • Step 1: Create a project
          • Step 2: Create a container
          • Step 3: Upload an object
          • Step 4: Download an object
          • Step 5: Copy Object to a Directory
          • Step 6: Delete the object and container
        • Features of vStorage
          • Working with projects
            • Projects overview
            • Project naming rules
            • Create a project
            • Viewing project properties
            • Resize a project
            • Renew a project
            • Auto-renew a project
            • Delete a project
            • Restore a project
            • IP Range ACLs for a project
          • Working with containers
            • Containers overview
            • Containers naming rule
            • Create a container
            • Viewing container properties
            • Search containers
            • Versioning container
            • Make container public
            • Make container private
            • ACLs for a container
            • CORS for a container
            • Container lifecycle
            • Delete a container
            • IP Range ACLs for a container
          • Working with directories and objects
            • Objects overview
            • Objects naming rule
            • Upload objects
            • Viewing directory and object properties
            • Search directories and objects
            • Share objects
            • Move objects
            • Copy objects
            • Rename an object
            • Set tags for objects
            • Set metadatas for objects
            • Download objects
            • Delete objects
            • Working with directories
          • Working with report
            • View summary reports across all regions
            • View summary reports on a specific region
            • View summary reports on a specific project
          • Working with trial project
          • Working with POC project
          • Working with vBackup project
          • Working with Archive project
        • Identity and Access Management
          • Managing vStorage access account
            • Root User Account
            • IAM User Account
              • Create an IAM User Account
              • Create Policies for IAM User Account
              • Attach Policies with IAM User Account
              • Delete an IAM User Account
            • Service Account
              • Create a Service Account
              • Create Policies for Service Account
              • Attach Policies with Service Account
              • vStorage Credentials
                • Create a S3 key
                • Create a Swift user
                • Attach S3 Keys and Swift Users to the Service Account
                • Delete S3 key, Swift user
              • Delete a Service Account
          • Managing Access to vStorage Resources
            • Access Permissions and Working Through vStorage
            • Access Permissions and Working Through IAM
            • Features, vStorage Resources, and Access Permissions
            • Access Permissions and Working Through Root User Account
            • Access Permissions and Working Through IAM User Account
            • Access Permissions and Working Through Service Account
        • 3rd Party Softwares
          • S3cmd
            • Integrating S3cmd with vStorage
            • Using S3cmd
          • Cyberduck
            • Integrating Cyberduck with vStorage
            • Using Cyberduck
          • Rclone
            • Integrating Rclone with vStorage
            • Using Rclone
          • Swift Client
            • Integrating SwiftClient with vStorage
            • Using SwiftClient
          • S3 SDK
            • Integrating S3 SDK with vStorage
            • Using S3 SDK
          • MinIO Client (MC)
            • Integrating MinIO Client with vStorage
            • Using MinIO Client
          • S3 Browser
            • Integrating S3 Browser with vStorage
            • Using S3 Browser
          • AWS CLI
            • Integrating AWS CLI with vStorage
            • Using AWS CLI
        • Resource Quota
        • Feature Limitations
        • Charging Fee
          • Charging for prepaid users
          • Charging for postpaid user
        • Monitoring vStorage
          • Monitoring vStorage Through Metrics
          • Monitoring vStorage Through Logs
        • Security
          • Access Control
          • Data in Transit Security
          • Data Security stored on vStorage
        • Usecase
          • Migrate data
            • [Rclone] Mount vStorage as Local Drive on Linux
            • [Rclone] Mount vStorage to Window server
            • [Rclone] Sync data from AWS S3 to vStorage
          • Optimize performance
        • API developers
          • vStorage API
            • Integrating vStorage API
            • Using vStorage API
          • vStorage Swift REST API
            • Integrating Swift REST API
            • Using Swift REST API
        • Storage gateway
          • Create and Use Storage Gateway
          • Replacing Fileserver with Gateway Application
      • Object storage (HCM04)
        • Getting Started with Object storage
          • Step 1: Create a project
          • Step 2: Create a bucket
          • Step 3: Upload/ Download objects
          • Step 4: Create a S3 Key
          • Step 5: Integrate 3rd party softwares with vStorage
          • Step 6: Use 3rd party softwares to action on vStorage
        • Features of Object Storage
          • Working with project
          • Working with bucket
            • Working with buckets via vStorage Portal
              • Bucket Versioning
              • Object Lock
              • Bucket Policy
              • Bucket ACLs
              • Bucket CORS
              • Bucket Event Notification
              • Bucket Lifecycle
            • Working with buckets via 3rd party software
          • Working with objects and directories
            • Working with objects and directories via vStorage Portal
            • Working with objects and directories via 3rd party software
          • Working with reports
        • Resource Quota
        • Access Management
          • Working with Root User Account
          • Working with IAM User Account
          • Working with Service Account
          • Working with S3 Keys
          • Limitation
        • API Developers
        • 3rd party softwares
          • S3cmd
            • Integrate S3cmd with vStorage
            • Using S3cmd
          • Cyberduck
            • Integrate Cyberduck with vStorage
            • Using Cyberduck
          • Rclone
            • Integrate Rclone with vStorage
            • Using Rclone
          • S3 SDK
            • Integrate S3 SDK with vStorage
            • Using S3 SDK
          • S3 Browser
            • Integrate S3 Browser with vStorage
            • Using S3 Browser
        • Use case
          • Migrate data
            • [Rclone] Mount vStorage on Window server
            • [Rclone] Mount vStorage as Local Drive on Linux
            • [Rclone] Sync data from AWS S3 to vStorage
        • Charging Fee
    • Filestorage
      • What is FileStorage?
      • Announcements and Updates
      • Getting Started with FileStorage
        • Create a Public NFS File Storage
        • Create a Private NFS File Storage
        • Create a Private SMB File Storage
          • Create a Private SMB File Storage without Active Directory
          • Create a Private SMB File Storage with Active Directory
          • Create a Private SMB File Storage without Active Directory
          • Create a Private SMB File Storage with Active Directory
      • Features of FileStorage
        • Create a File Storage
          • Create a NFS File Storage
          • Create a SMB File Storage without AD
          • Create a SMB File Storage with AD
        • Edit a File Storage
        • Resize a File Storage
        • Delete a File Storage
      • Specifications
      • Access Management
        • File Storage features, resources, and access
      • Resource Quota
      • Charging Fee
    • Backup with Veeam
      • Getting started with Veeam
        • Step 1: Install Veeam Backup & Replication
        • Step 2: Initialize Repository
        • Bước 3: Create Job backup
        • Step 4: Data Recovery on Veeam
      • Features of Veeam
      • Access Management
      • Charging Fee
      • Monitoring Service
      • Security
      • Use case
      • Glossary
  • Backup Center
    • Announcements and Updates
    • Cloud Backup
      • Get Started with Backup Server
      • Backup Location
        • Create and Manage backup locations
      • Backup Server
        • Create Backup Plan (Backup Server)
        • Create Backup Server Point
        • Backup Server Point Management
        • Restore resources
        • Change backup policy
        • Change backup location
      • Backup Policy
      • Pricing
      • Use case
        • Migrate backup server from vStorage to Vault (backup location)
    • Disaster Recovery Center (DRC)
      • Operating model
      • Server Disaster Recovery (SDR)
        • Getting Started with SDR
        • SDR Management
          • Automatically activate Snapshot
          • Attach a Server
          • Start Replication
          • Periodic Backup and Recovery Point
          • Test Failover
          • Failover
          • Stop & Resume Replication
          • Restart Replication
          • Recovery Point Retention
        • Pricing
        • Access Management
        • Security
        • Monitoring
        • Service Limits
  • vMonitor Platform
    • What is vMonitor Platform?
      • What is vMonitor Platform Metric?
        • Metric Quota Class
      • What is vMonitor Platform Log?
        • Log Project Class
      • What is vMonitor Platform Synthetic?
        • Synthetic Test Quota Class
    • Announcements and Updates
      • Announcement and Instructions on Switching Packages on the vMonitor Platform
    • Getting Start with vMonitor Platform
      • Getting Start with Metrics
      • Getting Start with Logs
      • Getting Start with Synthetic
    • Features of vMonitor Platform
      • Dashboard
        • Widget
          • Line
          • Bar
          • Stack area
          • Pie
          • Number
          • Table
          • Log search
        • Query
          • Metric query
          • Log query
        • Variable, Save Querying and View
      • Notification
        • Working with SMS Notification Quota
        • Working with Email Notification Quota
        • Working with Notification
          • SMS
          • Email
          • Slack
          • Teams
          • Telegram
          • Webhook
      • Alarm
        • Metric Alarm
        • Log Alarm
      • Metrics
        • Working with Metric Quota
        • Working with Metric Agent
          • Installing Metric Agent on Server
            • Linux OS
            • Linux OS has internet connection limitations
            • Window OS
        • Working with Metric Information
        • Working with Product Metric
          • Working with vServer-Metric
          • Working with vLB-Metric
          • Working with vDB-Metric
          • Working with vStorage-Metric
        • Applications support integration
          • Kubernetes
        • Supported Metrics List
          • List Host's metrics
          • List vServer's metric
          • List vLB's metrics
          • List vDB's metrics
          • List vStorage's metrics
      • Logs
        • Working with Log Project Quota
        • Working with Log Agent
          • Prepare to initiate log push connection
          • Create a Certificate
          • Install Log Agent on OS
            • CentOS
            • Debian/ Ubuntu
            • Windows
          • Install Log Agent on Docker
          • Install Log Agent on Kubernetes
        • Working with Log Project
          • Archive
          • Refill
          • Log mapping
          • Field mapping
        • Working with Log search
          • Search logs
          • Export logs
        • Working with Log pipeline
          • Processor Groups
          • Processor
            • Grok Parser
              • Grok Patterns
            • JSON Parser
            • CSV Parser
            • Field Remapper
            • Date Parser
            • GEO IP Parser
            • User-agent Parser
        • Working with Log2metric
        • Working with Product Logs
          • Working with vLB-Log
          • Working with vStorage-Log
          • Working with vCDN-Log
      • Synthetics
        • Working with Synthetic Test Quota
        • Working with Synthetic API Test
          • API Test with HTTP(s)
          • API Test with Ping
          • API Test with TCP
        • Working with Location
          • Public location
          • Private location
    • Identity and Access Management
    • Resource Quota
    • Pricing
    • Security
      • Access Permissions Security
      • Data Security During Transmission
  • VKS
    • What is VKS?
    • How VKS works?
    • Announcements and Updates
      • Release notes
    • Getting Started with VKS
      • Instructions for installing and configuring the kubectl in Kubenetes
      • Create a Public Cluster
        • Create a Public Cluster with Public Node Group
        • Create a Public Cluster with Private Node Group
          • Palo Alto as a NAT Gateway
          • Pfsense as a NAT Gateway
      • Create a Private Cluster
      • Expose a service through vLB Layer4
      • Expose a service through vLB Layer7
        • Automatically manage Certificates in VKS with Nginx Ingress Controller, Cert-Manager, and Let's Encr
      • Preserve Source IP when using NLB and Nginx LoadBalancer Controller
      • Integrate with Container Storage Interface (CSI)
      • Upgrading Control Plane Version
      • Upgrading Node Group Version
      • Use Terraform to create a Cluster and Node Group
      • Working with NVIDIA GPU Node Group
    • Clusters
      • Public Cluster and Private Cluster
      • Upgrading Control Plane Version
      • Whitelist
      • Stop POC
    • Node Groups
      • Auto Healing
      • Auto Scaling
      • Upgrading Node Group Version
      • Lable and Taint
    • Network
      • Working with Application Load Balancer (ALB)
        • Ingress for an Application Load Balancer
        • Configure for an Application Load Balancer
        • ALB Limitation
      • Working with Network load balancing (NLB)
        • Integrate with Network Load Balancer
        • Configure for a Network Load Balancer
        • NLB Limitation
      • CNI
        • Using CNI Calico Overlay
        • Using CNI Cilium Overlay
        • Using CNI Cilium VPC Native Routing
      • Load Balancer
        • Using Network Load Balancer
        • Using Application Load Balancer
      • Auto Scaling
      • Fleet Management
    • Storage
      • Working with Container Storage Interface (CSI)
        • Integrate with Container Storage Interface (CSI)
        • CSI Limitation
    • Security Group
    • Migration
      • Migrate Cluster from VKS to VKS
      • Migration Cluster from vContainer to VKS
      • Migrate Cluster from another platform to VKS
      • Migrate Limitation
    • Working VKS with Terraform
    • Monitoring
      • Metrics
    • Charging Fee
    • Reference
      • Kubernetes versions
      • Node Flavors
      • System Image
  • vDB
    • Relational Database Service (RDS)
      • Create a RDS Instance
      • Connect to RDS Instance
        • Connect to an RDS Instance via SSH Tunnel
      • Managing RDS Instance Information
      • Backing Up RDS Instance
      • Restoring RDS Instance
      • Managing Configuration Group in RDS Instance
      • Extend the usage period RDS Instance
      • Monitoring vDB with vMonitor Platform
      • Import Data into RDS Instance (MySQL/MariaDB) using mysqldump
      • Creating Read Replicas
      • Promote Read Relica to Standalone
      • vDB PostgreSQL - Supported Extensions
      • Configuring Replication with RDS (MySQL/MariaDB)
      • Attention & Limitations
    • MemoryStore Database Service (MDS)
      • Create MDS Instance
      • Connect MDS Instance
      • Manage MDS Instance
      • Manage MDS Config Group
      • Backup MDS Instance
    • Security (Bảo mật)
  • vCDN
    • Overview
      • What is CDN?
      • Overview Architecture
        • Network Architecture
        • Load Coordination Mechanism
        • Data Distribution Mechanism
          • PULL
          • PUSH
    • Getting Started with vCDN
      • Live Streaming
      • Video On Demand Streaming
      • Object Download
      • Web Accelerator
      • Transcoding and advanced features
        • Operating Model
        • Install Sigma Media Server
        • Use cases
          • Create Live Transcode Channel
          • Live Transcode combines recordings for later VOD playback
          • Create Simultaneous Restream Channels to Multiple Platforms (RTMP)
          • Transcode video files (MP4)
        • Sigma API developers
      • Using OBS Studio to Push Live Stream
    • Feature details
      • Security Link
      • CNAME
      • Cache Time
      • Development Mode
      • Origin
        • HTTP Origin
        • Object Storage S3
        • Host Origin
      • Optimize File Size
      • Cryptography
      • Caching
      • Automatically Redirect from HTTP to HTTPS
      • CDN Purge Cache
      • Page Rule
    • Access Management
    • Pricing
    • API Developers
    • Monitoring
    • Report
    • Security
      • Certificate Management
  • vCloudstack
    • Get Started with vCloudStack
      • Overview of features
      • Initialize VM on vCloudStack
      • Network Configuration
      • Load Balancer in vCloudStack
        • Create Application LB in vCloudStack
          • Listener for Application LB
          • Pool in vCloudstack
          • Certificate in vCloudstack
        • Create Network LB in vCloudStack
          • Listener for Network LB
          • Pool (NLB) in vCloudStack
        • Advanced Features
      • Volumes in vCloudStack
      • Backup in vCloudStack
      • Snapshots in vCloudStack
    • Get start with Admin Site
      • User Management
      • Access Management
      • Track resource usage information
      • Physical Infrastructure Monitoring
  • vContainer Registry
    • Getting Started
    • Repository
      • Create a repository
      • Edit quota limit
      • Manage image
      • Repository History
    • Repository user
      • Create repository user
      • Edit user information
      • Edit user permission
      • Refresh secret key
      • Change user status
  • vColocation
    • Accessing the vColo Customer Portal
    • Dashboard
    • Space list
      • View rack layout
      • View rack detail
      • Filter list
    • Ticket request
      • Open a ticket
      • Ticket list
  • DataSync
    • What is DataSync?
    • Announcements and Updates
    • Getting Start with DataSync
    • Features of DataSync
      • Create a Transfer Job
      • Run a Transfer Job
        • Run one time
        • Run schedule
      • Monitor Transfer Job Results
      • Stop a Transfer Job
      • Edit a Transfer Job
      • Xóa Transfer Job
      • Retry a Transfer Job
    • Identity and Access Management
      • Managing DataSync access account
        • Root User Account
        • IAM User Account
          • Create an IAM User Account
          • Create Policies for IAM User Account
          • Attach Policies with IAM User Account
          • Delete an IAM User Account
      • Managing Access to DataSync Resources
        • Features, DataSync Resources, and Access Permissions
        • Access Permissions and Working Through IAM
        • Access Permissions and Working Through Root User Account
    • Resoure Quota
    • Charging Fee
    • Monitoring
      • Monitoring DataSync Through Metrics
      • Monitoring DataSync Through Logs
    • Security
      • Data in Transit Security
      • Access Control
      • Data Security stored on vStorage
    • Usecase
      • Transfer data from Amazon S3 to vStorage
      • Transfer data from vStorage to vStorage cross account
      • Transfer data from vStorage to vStorage same account
  • vNetwork
    • Endpoint
      • Create Endpoint
      • Rename Endpoint
      • Delete Endpoint
      • View List of Endpoints
    • Public NAT Instance
      • Create NAT
      • Rename NAT
      • Delete NAT
      • Add/ Remove NAT Port
    • Cross Connect
      • Create Cross Connect
      • Create a VPC Connection
      • Delete Cross Connect
      • Resize Bandwidth
      • Bandwidth Packages
      • VPC Connection Conditions
      • UseCase
    • VPN (Virtual Private Network) Site To Site
      • Create VPN Site-to-Site
        • VPN Connect Condition
        • Add/Update/Delete more Site And Tunnel
        • Support IPSEC Configuration
      • Change VPN Bandwidth
      • VPN Packages
      • Delete VPN
      • Demo Site-to-Site VPN
      • FAQ
  • Key Management System
    • Customer Managed Key
    • VNG Cloud Managed Key
  • Service Health
  • Veka.ai
  • Identity and Access Management (IAM)
    • Getting Start with IAM
    • Common Usecases
      • Access control by job function
      • Access control to specific resources
      • Managing Resources with Terraform and Service Account
      • Use Deny permission to deny access
      • Authorization for access between root user accounts with Service Account Impersonate feature
    • IAM for VNG Cloud's Services
      • IAM for vServer
      • IAM for vStorage
      • IAM for vMonitor
      • IAM for DataSync
    • Types of IAM Identifiers
      • User Accounts
        • How to login to VNG Cloud
      • User Groups
      • Service accounts
      • vStorage Credential
      • Identity Providers
    • IAM Access Management
      • Access Management via Policy
      • VNG Managed Policy
    • Audit Logs Management
    • Limitation
    • Security for IAM
  • Billing & Payment
    • vConsole – Management channel for billing and resources
      • What is vConsole
      • Getting Started
    • What's Billing & Payment
    • Experience with Billing & Payment
      • Prepaid & Postpaid Users
      • Resource lifecycle management
        • Create resource
        • Resize resource configuration
        • Renew resource
        • Auto-renew resources - policy & terms
        • Recover resource
        • Delete resource
        • Resource POC
          • Converting resource from POC to Prepaid
      • Payment
        • Online payment
        • Payment of POC resources
        • Credit hold
        • Automatic invoice payment
        • Apply coupon at payment step
      • Invoice management
  • vCalculator - Service estimated tool
  • Partner Portal user guide
    • Partner Portal Overview
    • Partner Registration
    • Registration of Partner Discount
    • Registration of Partner's Customer
    • Set Up Discounts for Customers
    • Top up Credit for Customer
    • View Report on Partner Portal
    • DEAL Registration
    • View List of DEAL
    • View Detail Deal Information
    • Update Deal Stage
    • View Partner Discount by Deal
    • View Customer Discount by Deal
  • Getting start with VNG Cloud account
    • Register
    • Update Profile
    • Two-Factor Authentication (2FA)
    • Change Password Guide
    • Remove Account Guide
    • Change Phone Number Guide
  • FAQ
    • vServer
    • vStorage
    • vNetwork
    • vCDN
    • vDB
    • NTP server
    • DDoS
Powered by GitBook
On this page
  • 1. Authentication
  • 2. API Create live transcode channel
  • 3. Get information of a channel
  • 4. API start live channel
  • 5. API stop live channel
  • 6. Delete a channel
  • 7. List live sessions of a channel
  • 8. View the status of a session
  • 9. List the events of a session
  1. vCDN
  2. Getting Started with vCDN
  3. Transcoding and advanced features

Sigma API developers

PreviousTranscode video files (MP4)NextUsing OBS Studio to Push Live Stream

Last updated 6 months ago

LogoLogo

Address

  • VNG Corporation

Contact us

  • support@vngcloud.vn
  • 1900 1549

About us

  • About VNG Cloud
  • Get started our cloud

1. Authentication

  • First, you access the Figma application, select the App management menu then select the Credential tab:

  • Next, you enter the Username and select the corresponding permission group (here you group the Sigma Livestream Full permission ):

  • After you select Submit , the Sigma system will generate a Username and Secret Key . You need to save this password or download the credential file by selecting Download as .env file.

  • After having Username and Secret Key , you use Base64Encode tool to create token for Authorization header with the following syntax:

Authorization: Basic Base64Encode(<Username>:<Secret Key>)
  • Finally, you get App ID information by selecting the App management menu, selecting the General tab , then you can see App ID information as shown below.

2. API Create live transcode channel

To create a live transcode channel with the following settings:

  • Ultra-low-latency

  • Available in 03 profiles 1080p, 720p, 480p

  • Catchup live session saved to S3 storage (Note: re-enter channel name and S3 configuration)

You can use the following API:

curl --location 'https://api.sigma.video/api/livestream/channels' \
--header 'X-App-Id: <app_id>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <token>' \
--data '{
    "name": "<channel_name>",
    "description": null,
    "tags": [],
    "transcodeProfile": [
        "fbffbd08-ed7f-4a51-aabd-3132ac863bb5",
        "54a3d4db-a827-45ae-b6be-1faa21c2e7c6",
        "33a26869-0a1b-49a4-8303-1284ac8fd034"
    ],
    "type": "transcode",
    "mode": "ultra-low-latency",
    "stopTimeout": 30,
    "catchup": true,
    "record": false,
    "outputFormat": "hls",
    "machine": {
        "enabled": true,
        "machineId": "94e98078-b9cb-4d44-b16e-369fdb81da35",
        "machineType": "SIGMA_MACHINE"
    },
    "destinationCatchup": {
        "type": "s3",
        "s3": {
            "accessKey": "<s3_access_key>",
            "bucket": "<bucket_name>",
            "endpoint": "<s3_end_point>",
            "secretKey": "<s3_secrect_key>",
            "region": "<s3_region>",
            "segmentPrefix": null
        }
    }
}'

If the API call is successful, the HTTP Response code will be 201 , along with the response body being a json object in which the most important information is the id of the newly created channel as in the example below. This ID is used in the APIs to start/stop live sessions or delete channels.

{
    "id": "42efeee4-e94e-4444-b0a6-90850413519d",
    "name": "Channel_02",
    "description": null,
    …
}

3. Get information of a channel

After creating a channel, you can get the details of a channel by calling the following API:

curl --location 'https://api.sigma.video/api/livestream/channels/<channel_id>' \
--header 'X-App-Id: <app_id>' \
--header 'Authorization: Basic <token>'

If the API call is successful, the HTTP Response code will be 200 . It contains some important information such as:

  • currentSessionId: if the channel is in a livestream session, we will receive the session id.

  • For channels with catchup for VOD configured to be saved to S3, the endpoint to access the master.m3u8 file will look like this:<s3>/sigma-livestream/<session_id>/catchup/master-catchup.m3u8

  • rtmpServer: rtmp url to push stream.

  • streamToken: stream key.

  • liveStreamUrl: URL to watch live.

The received data will be as follows:b

{
    "id": "42efeee4-e94e-4444-b0a6-90850413519d",
    "name": "Channel_02",
    "description": null,
    "tags": [],
    "appId": "0c787e24-87a3-47da-a131-e8310f35aff7",
    "inputId": "e5418288-37be-4d0f-8221-f0c5e99efe5b",
    "transcodeProfile": […],
    "type": "transcode",
    "mode": "ultra-low-latency",
    "stopTimeout": 30,
    "catchup": true,
    "destinationCatchup": {
        "type": "s3",
        "s3": { … }
    },
    "record": false,
    "outputFormat": "hls",
    "status": "active",
    "machine": { … },
    "createdAt": "2024-07-22T10:34:36.772Z",
    "updatedAt": "2024-07-23T06:15:31.729Z",
    "currentSessionId": "977cc345-d771-4223-9306-07c2b9d49a34",
    "input": {
        "streamToken":"42efe-a050270cbbab47cbfacd-3519d",
        "rtmpServer":"rtmp://103.245.251.51:1935/livestream"
    },
    "liveStreamUrl": http://103.245.251.51:8080/manifest/42efeee4-e94e-4444-b0a6-90850413519d/master.m3u8,

} 

4. API start live channel

Use the API as follows to start a live channel:

curl --location --request PATCH 'https://api.sigma.video/api/livestream/channels/<channel_id>/start' \
--header 'X-App-Id: <app_id>' \
--header 'Authorization: Basic <token>'

If the API call is successful, the HTTP Response code will be 200 .

5. API stop live channel

Use the API as follows to stop a live channel:

curl --location --request DELETE 'https://api.sigma.video/api/livestream/channels/<channel_id>/stop' \
--header 'X-App-Id: <app_id>' \
--header 'Authorization: Basic <token>'

If the API call is successful, the HTTP Response code will be 200 .

6. Delete a channel

To delete a channel, use the API as follows:

curl --location 'https://api.sigma.video/api/livestream/sessions?q={"channelId":"<channel_id>"}&sort=updatedAt|desc&page=1&perPage=100' \
--header 'X-App-Id: <app_id>' \
--header 'Authorization: Basic <token>'

If the API call is successful, the HTTP Response code will be 200 .

7. List live sessions of a channel

Each livestream session of a channel will be tracked as a session. We can use the following API to get a list of sessions of a channel:

curl --location 'https://api.sigma.video/api/livestream/sessions?q={"channelId":"<channel_id>"}&sort=updatedAt|desc&page=1&perPage=100' \
--header 'X-App-Id: <app_id>' \
--header 'Authorization: Basic <token>'

If the API call is successful, the HTTP Response code will be 200. The result will be as shown in the following sample:

{
    "data": [
        {
            "name": "Channel_02_2024-07-22-11:33:50",
            "status": "ended",
            "appId": "0c787e24-87a3-47da-a131-e8310f35aff7",
            "recordUrls": [],
            "clientInfo": {
                "action": "on_publish",
                "stream": "42efe-a050270cbbab47cbfacd-3519d",
                "ip": "103.245.252.19",
                "client_id": "y1799srf",
                "param": "",
                "tcUrl": "rtmp://103.245.251.51:1935/livestream",
                "ips": [],
                "app": "livestream",
                "stream_id": "vid-4024822"
            },
            "duration": 40,
            "isCreateTask": true,
            "channelId": "42efeee4-e94e-4444-b0a6-90850413519d",
            "channel": {
                "id": "42efeee4-e94e-4444-b0a6-90850413519d",
                "name": "Channel_02",
                ...
            },
            "id": "5017085c-d828-491d-837f-2160df3e07c1",
            "events": [],
            "createdAt": "2024-07-22T11:33:50.903Z",
            "updatedAt": "2024-07-22T11:35:02.898Z",
            "startedAt": "2024-07-22T11:34:20.064Z",
            "finishedAt": "2024-07-22T11:35:02.898Z"
        },
        {
            "name": "Channel_02_2024-07-22-11:32:35",
            "status": "ended",
            "appId": "0c787e24-87a3-47da-a131-e8310f35aff7",
            "recordUrls": [],
            "clientInfo": {
                "action": "on_publish",
                "stream": "42efe-a050270cbbab47cbfacd-3519d",
                "ip": "103.245.252.19",
                "client_id": "ii05j356",
                "param": "",
                "tcUrl": "rtmp://103.245.251.51:1935/livestream",
                "ips": [],
                "app": "livestream",
                "stream_id": "vid-2wx9608"
            },
            "duration": 10,
            "isCreateTask": true,
            "channelId": "42efeee4-e94e-4444-b0a6-90850413519d",
            "channel": {
                "id": "42efeee4-e94e-4444-b0a6-90850413519d",
                "name": "Channel_02"
				...
            },
            "events": [],
            "createdAt": "2024-07-22T11:32:35.675Z",
            "updatedAt": "2024-07-22T11:33:19.362Z",
            "startedAt": "2024-07-22T11:33:05.117Z",
            "finishedAt": "2024-07-22T11:33:19.362Z"
        }
    ],
    "total": 2,
    "count": 2,
    "page": 1,
    "perPage": 100
}

8. View the status of a session

We can get the active status of a live session by calling the following API:

curl --location 'https://api.sigma.video/api/livestream/sessions/<session_id>/status' \
--header 'X-App-Id: <app_id>' \
--header 'Authorization: Basic <token>'

If the API call is successful, the HTTP Response code will be 200. The result will be as shown in the following sample:

{"status":"live"}

9. List the events of a session

During the operation of a session, actions such as: initialize, stop, start, signal interrupted, signal restored, etc. will be generated and tracked as events. We can use the API below to get a list of events:

curl --location 'https://api.sigma.video/api/livestream/events?q={"$and":[{"sessionId":"<session_id>"}]}&sort=updatedAt|desc&page=1&perPage=100' \
--header 'X-App-Id: <app_id>' \
--header 'Authorization: Basic <token>'

If the API call is successful, the HTTP Response code will be 200. The result will be as shown in the following sample:

{
    "data": [
        {
            "actor": "user",
            "action": "ended",
            "sessionId": "5017085c-d828-491d-837f-2160df3e07c1",
            "id": "3b393448-65a8-4258-a418-2bfaa8cda40d",
            "createdAt": "2024-07-22T11:35:02.901Z",
            "updatedAt": "2024-07-22T11:35:02.901Z",
            "message": "Kênh đã kết thúc"
        },
        {
            "action": "stable",
            "sessionId": "5017085c-d828-491d-837f-2160df3e07c1",
            "id": "66df86b4-c0ed-4db7-868c-a12ca1830c58",
            "createdAt": "2024-07-22T11:34:20.063Z",
            "updatedAt": "2024-07-22T11:34:20.063Z",
            "message": "Kênh ổn định"
        }
	]
}