网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
本文导读

展开导读

对象模型

更新时间:2023-02-27 GMT+08:00
分享

本节介绍API及后端服务的对象模型。

说明:
  • “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作:

    C:创建;U:更新;R:读取。

  • “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。
表1 API对象模型

参数

类型

说明

操作类型

是否必选

id

String

API的编号

R

-

name

String

API的名称

CRU

group_id

String

API所属分组的编号

CR

type

Integer

API的类型:

  • 1:公有API
  • 2:私有API

CRU

status

Integer

API的状态:

  • 1:启用
  • 2:禁用
  • 3:已删除

默认1

该字段已废弃

R

-

version

String

API的版本

CRU

req_protocol

String

API的访问协议

  • HTTP
  • HTTPS
  • BOTH:同时支持HTTP和HTTPS

默认:HTTPS

CRU

req_method

String

API的访问方式

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

CRU

req_uri

String

API的访问地址,不含域名、端口号、请求协议等,是URI

CRU

auth_type

String

API的认证方式

  • NONE:无认证
  • APP:APP认证
  • IAM:IAM认证
  • AUTHORIZER:自定义认证

CRU

authorizer_id

String

前端自定义认证对象的ID

CRU

match_mode

String

API的路由匹配方式:

  • SWA:前缀匹配
  • NORMAL:正常匹配

CRU

arrange_necessary

Integer

是否需要编排

  • 1:是
  • 2:否

目前默认为:2

R

-

backend_type

String

后端服务类型:

  • HTTP:web后端
  • FUNCTION:函数服务
  • MOCK: MOCK

CRU

register_time

Timestamp

API创建时间

R

-

update_time

Timestamp

API修改时间

R

-

remark

String

API描述

CRU

tag

String

API标签

CRU

cors

String

是否支持跨域

  • TRUE 支持
  • FALSE 不支持

默认:FALSE

CRU

response_id

String

分组自定义响应ID

CRU

表2 web后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

status

Integer

状态:

  • 1:启用
  • 2:禁用
  • 3:已删除

默认1

该字段已废弃

R

-

version

String

版本

CRU

url_domain

String

后端endpoint

CRU

req_protocol

String

访问协议

  • HTTP
  • HTTPS

CRU

req_method

String

请求方式

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

CRU

req_uri

String

访问地址,是URI

CRU

timeout

Integer

超时时间,单位:毫秒(1-60000)

CRU

front_api_id

String

对应的API编号

R

-

register_time

Timestamp

创建时间

R

-

update_time

Timestamp

修改时间

R

-

remark

String

描述

CRU

vpc_status

Integer

是否使用VPC通道

  • 1:使用
  • 2:不使用

CRU

否,默认不使用

vpc_info

String

VPC通道信息

CRU

如果vpc_status=1,即:使用VPC通道,则该字段必填

authorizer_id

String

后端自定义认证对象的ID

CRU

表3 MOCK后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

status

Integer

状态:

  • 1:启用
  • 2:禁用
  • 3:已删除

默认1

该字段已废弃

R

-

version

String

版本

CRU

result_content

String

返回结果

CRU

register_time

Timestamp

创建时间

R

-

update_time

Timestamp

修改时间

R

-

remark

String

描述

CRU

表4 函数工作流对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

status

Integer

状态:

  • 1:启用
  • 2:禁用
  • 3:已删除

默认1

该字段已废弃

R

-

version

String

函数版本号

CRU

function_urn

String

函数的URN

CRU

invocation_type

String

函数类型:async|sync(异步|同步)

CRU

timeout

Integer

超时时间(1-60000),单位:毫秒

CRU

register_time

Date

创建时间

R

-

update_time

Date

修改时间

R

-

remark

String

描述

CRU

表5 请求参数对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

name

String

参数名称

CRU

type

String

参数类型:

  • string
  • number

CRU

location

String

参数位置:

  • PATH
  • QUERY
  • HEADER
  • FORMDATA

CRU

default_value

String

参数默认值

CRU

sample_value

String

参数示例值

CRU

required

Integer

参数是否必须:

  • 1:是
  • 2:否

CRU

valid_enable

Integer

是否开启参数校验:

  • 1:是
  • 2:否

CRU

remark

String

参数描述

CRU

enumerations

String

参数枚举值

CRU

min_num

String

参数最小值

CRU

max_num

String

参数最大值

CRU

min_size

Integer

参数最小长度

CRU

max_size

Integer

参数最大长度

CRU

regular

String

正则校验规则(暂不支持)

CRU

json_schema

String

JSON校验规则(暂不支持)

CRU

表6 后端参数对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

req_param_id

String

对应的请求参数的编号

R

-

name

String

参数名称

CRU

location

String

参数位置:

  • PATH
  • QUERY
  • HEADER
  • FORMDATA

CRU

origin

String

参数类型:

  • REQUEST
  • CONSTANT
  • SYSTEM

CRU

value

String

参数值:

  • 类型为REQUEST时,值为请求参数的参数名称。
  • 类型为SYSTEM时,值为网关参数名称。
  • 类别为CONSTANT时,值为参数真正的值。

CRU

remark

String

描述

CRU

policy_id

String

关联的策略条件编号

CRU

表7 WEB策略后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

name

String

策略后端名称

CRU

url_domain

String

后端endpoint

CRU

req_protocol

String

访问协议

  • HTTP
  • HTTPS

CRU

req_method

String

请求方式

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

CRU

req_uri

String

访问地址,是URI

CRU

timeout

Integer

超时时间,单位:毫秒(1-60000)

CRU

vpc_status

Integer

是否使用VPC通道

  • 1:使用
  • 2:不使用

CRU

否,默认不使用

vpc_info

String

VPC通道信息

CRU

如果vpc_status=1,即:使用VPC通道,则该字段必填

effect_mode

String

关联的策略组合模式

  • ALL
  • ANY

CRU

表8 MOCK策略后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

name

String

策略后端名称

CRU

result_content

String

返回结果

CRU

effect_mode

String

关联的策略组合模式

  • ALL
  • ANY

CRU

表9 函数工作流策略后端对象模型

参数

类型

说明

操作类型

是否必选

id

String

编号

R

-

front_api_id

String

对应的API编号

R

-

name

String

策略后端名称

CRU

version

String

函数版本号

CRU

function_urn

String

函数的URN

CRU

invocation_type

String

函数类型:async|sync(异步|同步)

CRU

timeout

Integer

超时时间(1-60000),单位:毫秒

CRU

effect_mode

String

关联的策略组合模式

  • ALL
  • ANY

CRU

表10 策略后端条件对象模型

参数

类型

说明

操作类型

是否必选

id

String

策略后端条件对象的编号

R

-

condition_type

String

策略条件:

  • exact:绝对匹配
  • enum:枚举
  • pattern:正则

CRU

condition_value

String

策略值

CRU

condition_origin

String

策略类型:

  • param:参数
  • source:源IP

CRU

req_param_id

String

关联的请求参数对象编号

R

-

policy_backend_id

String

关联的策略后端对象编号

CRU

表11 认证方式参数对象模型

参数

类型

说明

操作类型

是否必选

app_code_auth_type

String

AppCode简易认证类型,仅在auth_type为APP时生效,默认为DISABLE:

  • DISABLE:不开启简易认证
  • HEADER:开启简易认证且AppCode位置在HEADER

CRU

-

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容