计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
态势感知 SA
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询后端API列表

功能介绍

获取某个实例下的所有后端API。

URI

GET /v1/{project_id}/apic/instances/{instance_id}/livedata-apis

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

String

实例ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Long

偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0

缺省值:0

limit

Integer

每页显示的条目数量

最小值:1

最大值:500

缺省值:20

app_id

String

后端API归属的集成应用编号

app_name

String

后端API归属的集成应用名称

name

String

后端API名称

status

String

后端API状态,支持1,3,4,分别表示待开发,开发中和已部署状态

path

String

后端API请求路径

precise_search

String

指明需要精准查询的参数,支持name、path、status

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

apis

Array of LdApiInfo objects

本次查询到的API列表

表5 LdApiInfo

参数

参数类型

描述

name

String

后端API名称。

支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头。

最小长度:3

最大长度:100

path

String

后端API请求路径。

支持英文、数字、中划线、下划线、点等,且以斜杠(/)开头。

更新后端API时,status=4为后端API的已部署状态,该状态下后端API请求路径不能修改。

最小长度:2

最大长度:256

method

String

后端API请求方法。

支持GET、PUT、POST、DELETE

更新后端API时,status=4为后端API的已部署状态,该状态下后端API请求方法不能修改。

description

String

后端API描述。

不支持<,>字符

最小长度:0

最大长度:1000

version

String

后端API版本

支持英文,数字,下划线,中划线,点。

最小长度:1

最大长度:63

content_type

String

后端API返回类型

缺省值:json

api_signature_id

String

后端API为签名认证时绑定的签名密钥编号

最小长度:1

最大长度:64

roma_app_id

String

后端API归属的集成应用编号

更新后端API时,status=4为后端API的已部署状态,该状态下后端API归属的集成应用编号不能修改。

最小长度:1

最大长度:65

return_format

Boolean

API响应信息是否格式化

true: 对响应信息进行格式化

false:对响应信息格式化不进行格式化

缺省值:false

parameters

Array of LdApiParameter objects

后端API的请求参数列表

id

String

后端API编号

instance

String

后端API所属实例编号

type

String

后端API类型:

  • data:数据后端

  • function: 函数后端

status

Integer

后端API状态:

  • 1:待开发

  • 3:开发中

  • 4:已部署

created_time

String

后端API创建时间

modified_time

String

后端API修改时间

scripts

Array of LdApiScript objects

后端API脚本信息

roma_app_name

String

后端API归属的集成应用名称

表6 LdApiParameter

参数

参数类型

描述

name

String

参数名称:

  • 参数位于Headers、 Parameters时,用户自行定义,支持英文、数字、点、中划线、下划线,且需要英文开头,不区分大小写。

  • 参数位于Body时候,参数以application/json、application/xml、application/text为名,但实际是以请求body里的键值对作为参数名和参数值,比如请求消息样例,参数名为application/json,参数值为{"table":"apic01","id":"1"},后端取table:apic01,id:1这两个键值对作为入参。

  • 注意:定义参数不要重名,否则会覆盖掉,当Headers、Parameters重复时候,Parameters会被覆盖,当Parameters和Body里的键值对重复时候,Parameters会被覆盖。

最小长度:1

最大长度:32

in

String

该参数在调用API时候所放的位置:

  • Headers :放于请求头

  • Parameters :放于请求参数

  • Body:放于请求体

default

String

参数默认值

最大长度:4000

description

String

参数描述

不支持<,>字符

最小长度:0

最大长度:255

required

Boolean

参数是否必须。true:必须,false:不必须

缺省值:false

表7 LdApiScript

参数

参数类型

描述

ds_id

String

数据源编号,当api_type = data时,必选

ds_name

String

数据源名称

ds_type

String

数据源类型:

  • oracle:oracle数据源类型

  • mysql:mysql数据源类型

  • mongodb:mongodb数据源类型

  • redis:redis数据源类型

  • postgresql:postgresql/opengauss数据源类型

  • hive:hive数据源类型

  • mssql:sqlserver数据源类型

  • sqlserver:sqlserver数据源类型

  • dws:dws数据源类型

  • gauss100:gauss100数据源类型

  • zenith:zenith数据源类型

  • hana: hana数据源类型

  • clickhouse: clickhouse数据源类型

  • mrshive: mrshive数据源类型(tag:Site_hybrid)

  • dm : dameng数据源类型(tag:hcs)

  • opengauss : opengauss数据源类型(tag:hcs)

type

String

脚本类型

  • SQL:sql语句

  • SP:存储过程

object_name

String

返回对象。

最小长度:1

最大长度:32

content

String

API脚本内容

请对脚本进行base64编码

最小长度:1

最大长度:100000

enable_result_paging

Boolean

数据脚本是否结果分页,当api_type = data时有效

缺省值:false

enable_preparestatement

Boolean

数据脚本是否预编译,当api_type = data时有效

缺省值:false

created_time

String

后端API脚本创建时间

modified_time

String

后端API脚本修改时间

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码: 200

OK

{
  "total" : 1,
  "size" : 1,
  "apis" : [ {
    "content_type" : "json",
    "created_time" : "2020-09-18T09:25:59Z",
    "description" : "",
    "id" : "bd42841c20184da6bbf457c6d8a06e37",
    "instance" : "f0fa1789-3b76-433b-a787-9892951c620e",
    "method" : "GET",
    "modified_time" : "2020-09-18T09:37:28Z",
    "name" : "livedata_api_demo",
    "parameters" : [ ],
    "path" : "/test/function",
    "return_format" : false,
    "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d",
    "roma_app_name" : "app-demo",
    "scripts" : [ ],
    "status" : 1,
    "type" : "",
    "version" : "1.0.1"
  } ]
}

状态码: 400

Bad Request

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

状态码: 401

Unauthorized

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

状态码: 403

Forbidden

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

状态码: 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

状态码: 500

Internal Server Error

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容