华为云首页 用户手册

数据治理中心 DataArts Studio-查询API信息:响应

数据治理中心 DataArts Studio-查询API信息:响应

时间：2023-11-01 16:20:39
数据治理中心 DataArts Studio

响应

  • 响应样例
    {"backend_config": null,"create_time": 1589186805000,"datasource_config": {"access_mode": "SQL","backend_paras": [{"condition": "CONDITION_TYPE_EQ","mapping": "a1","name": "p"},{"condition": "CONDITION_TYPE_EQ","mapping": "a3","name": "q"},{"condition": "CONDITION_TYPE_EQ","mapping": "a2","name": "h"}],"connection_id": "8a94809170fa181e0170fd2cbb610007","database": "default","order_paras": [{"field": "a1","name": "o1","optional": false,"order": 1,"sort": "ASC"},{"field": "a2","name": "o2","optional": true,"order": 2,"sort": "CUSTOM"}],"pagination": "DEFAULT","queue": "default","response_paras": [{"description": "","example_value": "","field": "a1","name": "a1x","type": "REQUEST_PARAMETER_TYPE_STRING"},{"description": "","example_value": "","field": "a2","name": "a2","type": "REQUEST_PARAMETER_TYPE_STRING"},{"description": "","example_value": "1","field": "a3","name": "a3","type": "REQUEST_PARAMETER_TYPE_NUMBER"}],"sql": null,"type": "DLI"},"description": "update","host": "e7c91cd2d4714e81807b7d4c273f791c.apig.xxxxxx.apis.com","id": "f2108870c3867c3080cf5dfcc1f1a66c","log_flag": true,"manager": "test","name": "testOpenApi_create_configuration_update","path": "/testOpenApi_configuration/{p}","protocol": "PROTOCOL_TYPE_HTTP","publish_type": "PUBLISH_TYPE_PRIVATE","request_paras": [{"default_value": "","description": "","example_value": "","name": "h","necessary": false,"position": "REQUEST_PARAMETER_POSITION_HEADER","type": "REQUEST_PARAMETER_TYPE_STRING"},{"default_value": null,"description": "123","example_value": null,"name": "p","necessary": true,"position": "REQUEST_PARAMETER_POSITION_PATH","type": "REQUEST_PARAMETER_TYPE_NUMBER"},{"default_value": null,"description": "","example_value": null,"name": "q","necessary": true,"position": "REQUEST_PARAMETER_POSITION_QUERY","type": "REQUEST_PARAMETER_TYPE_NUMBER"}],"request_type": "REQUEST_TYPE_GET","update_time": 1589202148000,"create_user": "abc","debug_status": "API_DEBUG_SUCCESS","group_id": "123","hosts": null,"status": "API_STATUS_CREATED"}
  • 响应Body参数

    参数

    参数类型

    描述

    id

    String

    API的ID

    name

    String

    API名称

    group_id

    String

    API所属分组的ID

    description

    String

    API 描述

    protocol

    String

    API 访问协议

    枚举值：

    • PROTOCOL_TYPE_HTTP
    • PROTOCOL_TYPE_HTTPS

    publish_type

    String

    发布类型，公开或者私有

    枚举值：

    • PUBLISH_TYPE_PUBLIC
    • PUBLISH_TYPE_PRIVATE

    log_flag

    Boolean

    是否开启日志记录

    path

    String

    API的访问路径

    host

    String

    共享版域名

    hosts

    InstanceHostDTO object

    专享版域名

    request_type

    String

    API访问方式

    枚举值：

    • REQUEST_TYPE_POST
    • REQUEST_TYPE_GET

    create_user

    String

    API创建者

    create_time

    Long

    创建时间

    update_time

    Long

    更新时间

    manager

    String

    API 审核人名称

    status

    String

    API的状态

    枚举值：

    • API_STATUS_CREATED
    • API_STATUS_PUBLISH_WAIT_REVIEW
    • API_STATUS_PUBLISH_REJECT
    • API_STATUS_PUBLISHED
    • API_STATUS_WAITING_STOP
    • API_STATUS_STOPPED
    • API_STATUS_RECOVER_WAIT_REVIEW
    • API_STATUS_WAITING_OFFLINE
    • API_STATUS_OFFLINE
    • API_STATUS_OFFLINE_WAIT_REVIEW

    type

    String

    API 类型

    枚举值：

    • API_SPECIFIC_TYPE_CONFIGURATION
    • API_SPECIFIC_TYPE_SCRIPT
    • API_SPECIFIC_TYPE_REGISTER

    debug_status

    String

    API调试状态

    枚举值：

    • API_DEBUG_WAITING
    • API_DEBUG_FAILED
    • API_DEBUG_SUCCESS

    request_paras

    Array of RequestPara objects

    API请求参数

    datasource_config

    DatasourceConfig object

    数据源配置

    backend_config

    BackendConfig object

    后端配置
    表1 InstanceHostDTO

    参数

    参数类型

    描述

    instance_id

    String

    集群id

    instance_name

    String

    集群名

    intranet_host

    String

    内网地址

    external_host

    String

    外网地址

    domains

    Array of strings

    网关域名
    表2 RequestPara

    参数

    参数类型

    描述

    name

    String

    参数名

    position

    String

    参数的位置

    枚举值：

    • REQUEST_PARAMETER_POSITION_PATH
    • REQUEST_PARAMETER_POSITION_HEADER
    • REQUEST_PARAMETER_POSITION_QUERY

    type

    String

    参数的类型

    枚举值：

    • REQUEST_PARAMETER_TYPE_NUMBER
    • REQUEST_PARAMETER_TYPE_STRING

    description

    String

    参数的描述

    necessary

    Boolean

    参数是否必填

    example_value

    String

    实例值

    default_value

    String

    默认值
    表3 DatasourceConfig

    参数

    参数类型

    描述

    type

    String

    数据源的类型

    枚举值：

    • MYSQL
    • DLI
    • DWS
    • HIVE
    • HBASE

    connection_name

    String

    数据连接名称

    connection_id

    String

    数据连接ID

    database

    String

    数据库名

    datatable

    String

    数据表名称

    table_id

    String

    数据表ID

    queue

    String

    DLI的队列名称

    access_type

    String

    取数方式

    枚举值：

    • SCRIPT
    • CONFIGURAITON

    access_mode

    String

    获取数据的模式

    枚举值：

    • SQL
    • ROW_KEY
    • PREFIX_FILTER

    pagination

    String

    枚举值：

    • DEFAULT
    • CUSTOM

    sql

    String

    脚本模式下的sql语句

    backend_paras

    Array of ApiRequestPara objects

    API后端参数

    response_paras

    Array of ApiResponsePara objects

    配置类API返回参数

    order_paras

    Array of DatasourceOrderPara objects

    排序参数
    表4 ApiRequestPara

    参数

    参数类型

    描述

    name

    String

    参数名称

    mapping

    String

    映射字段

    condition

    String

    操作符

    枚举值：

    • CONDITION_TYPE_EQ
    • CONDITION_TYPE_NE
    • CONDITION_TYPE_GT
    • CONDITION_TYPE_GE
    • CONDITION_TYPE_LT
    • CONDITION_TYPE_LE
    • CONDITION_TYPE_LIKE
    • CONDITION_TYPE_LIKE_L
    • CONDITION_TYPE_LIKE_R
    表5 ApiResponsePara

    参数

    参数类型

    描述

    name

    String

    参数名

    field

    String

    绑定的表字段

    type

    String

    参数类型

    枚举值：

    • REQUEST_PARAMETER_TYPE_NUMBER
    • REQUEST_PARAMETER_TYPE_STRING

    description

    String

    参数描述

    example_value

    String

    参数示例值
    表6 DatasourceOrderPara

    参数

    参数类型

    描述

    name

    String

    排序参数名称

    field

    String

    对应的参数字段

    optional

    Boolean

    是否可选

    sort

    String

    排序方式

    枚举值：

    • ASC
    • DESC
    • CUSTOM

    order

    Integer

    排序参数顺序
    表7 BackendConfig

    参数

    参数类型

    描述

    type

    String

    后端请求类型

    枚举值：

    • REQUEST_TYPE_POST
    • REQUEST_TYPE_GET

    protocol

    String

    后端请求协议类型

    枚举值：

    • PROTOCOL_TYPE_HTTP
    • PROTOCOL_TYPE_HTTPS

    host

    String

    后端host

    timeout

    Integer

    后端超时时间

    path

    String

    后端请求Path

    backend_paras

    Array of BackendRequestPara objects

    API后端参数

    constant_paras

    Array of BackendConstant objects

    后端常量参数
    表8 BackendRequestPara

    参数

    参数类型

    描述

    name

    String

    api请求参数名称

    position

    String

    参数位置

    枚举值：

    • REQUEST_PARAMETER_POSITION_PATH
    • REQUEST_PARAMETER_POSITION_HEADER
    • REQUEST_PARAMETER_POSITION_QUERY

    backend_para_name

    String

    对应的后端参数
    表9 BackendConstant

    参数

    参数类型

    描述

    name

    String

    常量参数名

    type

    String

    常量参数类型

    枚举值：

    • REQUEST_PARAMETER_TYPE_NUMBER
    • REQUEST_PARAMETER_TYPE_STRING

    position

    String

    常量参数位置

    枚举值：

    • REQUEST_PARAMETER_POSITION_PATH
    • REQUEST_PARAMETER_POSITION_HEADER
    • REQUEST_PARAMETER_POSITION_QUERY

    description

    String

    常量参数描述

    value

    String

    常量参数值
support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0419.html
看了此文的人还看了
CDN加速 GaussDB 文字转换成语音 免费的服务器 如何创建网站 域名网站购买 私有云桌面 云主机哪个好 域名怎么备案 手机云电脑 SSL证书申请 云点播服务器 免费OCR是什么 电脑云桌面 域名备案怎么弄 语音转文字 文字图片识别 云桌面是什么 网址安全检测 网站建设搭建 国外CDN加速 SSL免费证书申请 短信批量发送 图片OCR识别 云数据库MySQL 个人域名购买 录音转文字 扫描图片识别文字 OCR图片识别 行驶证识别 虚拟电话号码 电话呼叫中心软件 怎么制作一个网站 Email注册网站 华为VNC 图像文字识别 企业网站制作 个人网站搭建 华为云计算 免费租用云托管 云桌面云服务器 ocr文字识别免费版 HTTPS证书申请 图片文字识别转换 国外域名注册商 使用免费虚拟主机 云电脑主机多少钱 鲲鹏云手机 短信验证码平台 OCR图片文字识别 SSL证书是什么 申请企业邮箱步骤 免费的企业用邮箱 云免流搭建教程 域名价格
数据治理中心 DataArts Studio-查询API信息:响应

搜索反馈

您搜索到想要的结果了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
热门活动
推荐文章
更多内容
云硬盘存储EVS Web应用防火墙 人机语音识别 开发者大会2023 云计算入门 云数据库选择 HDC大会 华为云计算 响应式建站是什么 智慧班牌系统