このページは、お客様の言語ではご利用いただけません。Huawei Cloudは、より多くの言語バージョンを追加するために懸命に取り組んでいます。ご協力ありがとうございました。

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/ ROMA Connect/ API Reference/ Service Integration APIs/ Custom Backend Management/ Querying the Deployment History of a Backend API
Updated on 2023-06-29 GMT+08:00

Querying the Deployment History of a Backend API

Function

This API is used to query the deployment records of a backend API in an instance.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id}/deploy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

ld_api_id

Yes

String

Backend API ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

histories

Array of LdApiDeployHistoryInfo objects

Deployment history objects of a backend API.

Table 4 LdApiDeployHistoryInfo

Parameter

Type

Description

id

String

Deployment ID.

ld_api_id

String

ID of the deployed backend API.

group_id

String

ID of the deployed frontend API group.

env_id

String

ID of the deployed environment.

api_id

String

ID of the deployed frontend API.

deploy_time

String

Deployment time.

api_definition

LdApiInfo object

Custom backend API details.

Table 5 LdApiInfo

Parameter

Type

Description

name

String

Backend API name.

Must start with a letter or digit and can include letters, digits, and special characters -_./():

Minimum: 3

Maximum: 100

path

String

Backend API request path.

Must start with a slash (/) and can include letters, digits, hyphens (-), underscores (_), and periods (.).

Minimum: 2

Maximum: 256

method

String

Backend API request method, which can be GET, PUT, POST, or DELETE.

description

String

Backend API description, which cannot contain < and >.

Minimum: 0

Maximum: 1000

version

String

Backend API version, which contains 2 to 16 characters excluding < and >.

Minimum: 2

Maximum: 64

content_type

String

Type of the returned backend API.

Default: json

api_signature_id

String

ID of the signature key bound to the API for signature authentication

Minimum: 1

Maximum: 64

roma_app_id

String

ID of the integration application to which the backend API belongs.

Minimum: 1

Maximum: 65

return_format

Boolean

Indicates whether to format the API response information.

true: The response information is formatted.

false: The response information is not formatted.

Default: false

parameters

Array of LdApiParameter objects

Backend API request parameters.

id

String

Backend API ID.

instance

String

ID of the instance to which the backend API belongs.

type

String

Backend API type:

  • data

  • function

status

Integer

Backend API status:

  • 1: to be developed

  • 3: developing

  • 4: deployed

created_time

String

Time when the backend API is created.

modified_time

String

Time when the backend API is modified.

scripts

Array of LdApiScript objects

Backend API script.

roma_app_name

String

Name of the integration application to which the backend API belongs.

Table 6 LdApiParameter

Parameter

Type

Description

name

String

Parameter name.

  • If the parameter is located in Headers or Parameters, the value can contain letters, digits, periods (.), hyphens (-), and underscores (_), and must start with a letter. The value is case-insensitive.

  • If the parameter is located in Body, it is named application/json, application/xml, or application/text. However, the key-value pair in Body is used as the parameter name and parameter value. For example, if the parameter name is application/json and the parameter value is {"table":"apic01","id":"1"}, the backend uses table:apic01 and id:1 as input parameters.

  • Note: The parameter name must be unique. Otherwise, the parameters will be overwritten. When the parameters in Headers and Parameters are duplicate, the parameters will be overwritten. When the key-value pairs in Parameters and Body are duplicate, the parameters will be overwritten.

Minimum: 1

Maximum: 32

in

String

Position of the parameter during API calling:

  • Headers

  • Parameters

  • Body

default

String

Default value.

Maximum: 4000

description

String

Parameter description, which cannot contain < and >.

Minimum: 0

Maximum: 255

required

Boolean

Whether the parameter is mandatory. true: The parameter is mandatory. false: The parameter is optional.

Default: false

Table 7 LdApiScript

Parameter

Type

Description

ds_id

String

Data source ID. This parameter is mandatory only if api_type is set to data.

ds_name

String

Data source name.

ds_type

String

Data source type.

  • oracle: Oracle data source type

  • mysql: MySQL data source type

  • mongodb: MongoDB data source type

  • redis: Redis data source type

  • postgresql: PostgreSQL/OpenGauss data source type

  • hive: Hive data source type

  • mssql: SQL Server data source type

  • sqlserver: SQL Server data source type

  • dws: DWS data source type

  • gauss100: GaussDB 100 data source type

  • zenith: zenith data source type

type

String

Script type.

  • SQL: SQL statement

  • SP: stored procedure

object_name

String

Returned object.

Minimum: 1

Maximum: 32

content

String

API script content.

Perform Base64 encoding on the script.

Minimum: 1

Maximum: 100000

enable_result_paging

Boolean

Indicates whether to display the data script result on multiple pages. This parameter is mandatory only if api_type is set to data.

Default: false

enable_preparestatement

Boolean

Indicates whether to pre-compile the data script. This parameter is mandatory only if api_type is set to data.

Default: false

created_time

String

Time when the backend API script is created.

modified_time

String

Time when the backend API script is modified.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "histories" : {
    "api_id" : "1d0432f1a82a49d08b9308ae7bd96ca6",
    "deploy_time" : "2020-09-28T11:01:09Z",
    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "group_id" : "01ce7564a2544713b80c7c08eb85f5d0",
    "id" : "abbe44b56eda428d84172343674c9cd6",
    "ld_api_id" : "bd42841c20184da6bbf457c6d8a06e37"
  }
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3084",
  "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more