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

Managing API Versions

Updated on 2025-02-18 GMT+08:00

Scenario

DataArts DataService allows you to manage APIs by version, and debug and publish APIs of different versions.

You can also track API changes by API version and compare versions. The system retains 10 latest version records.

Prerequisites

  • API version management is supported only in the exclusive edition.
  • To update an API version, you need to edit a published API and publish it again. An API cannot be edited and the API version cannot be updated if it is in the pending review or execution state after published, unpublished, suspended, or resumed.

Updating an API Version

To update an API version, you need to edit a published API and publish it again.

  1. On the DataArts Studio console, locate a workspace and click DataArts DataService.
  1. In the left navigation pane, choose Exclusive. The Overview page is displayed.
  2. Choose API Development > APIs. Ensure that the API you want to update is in Published state and click Edit in the Operation column.
  3. On the Edit API page, you can modify the basic configuration or data extraction logic of the API, such as the API catalog, description, request method, input parameters, and data extraction method. The API name, request path, protocol, and security authentication cannot be changed.
    Figure 1 Modifying the basic configuration or data extraction logic of the API

  4. After modifying the API, click Next. On the displayed page, set related parameters and test the API.
    You can configure API request parameters in the left pane. See Table 1 for parameter details. The request information sent by the API and the returned result after the API request is invoked are displayed on the right.
    Table 1 Debugging APIs

    Parameter

    Description

    API Version

    Only specified API versions in DataArts DataService Exclusive can be debugged.

    If the API version is not specified, unpublished APIs will be debugged by default.

    Parameters

    Query parameters and their values.

    Cluster Settings

    Supported only by Exclusive Edition. Select the instance where the API to be debugged resides.

  5. After the test is complete, click OK to return to the API list. Edited is displayed next to the name of the API that you have modified.
    Figure 2 Editing an API

  6. Publish the edited API again. In the API list, locate the API you have edited, click More in the Operation column, and select Publish. In the displayed dialog box, select a cluster you have debugged.

    You can publish the API to the cluster where the API was published last time. Then the API information in the cluster will be updated. You can also publish the API to another cluster. Then this API has different versions in different clusters.

Viewing and Comparing Versions

  1. On the DataArts Studio console, locate a workspace and click DataArts DataService.
  1. In the navigation pane on the left, choose Exclusive. The Overview page is displayed.
  2. Choose API Development > API Catalogs or API Development > APIs.
  3. On the API details page, click the Version Management tab to view the versions of the API. A maximum of 10 latest versions are retained.
    You can view the details of an API version, or delete or publish a version. You can also select two versions and click Compare Version to compare them.
    Figure 3 Managing API versions

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