华为云首页 用户手册

API网关 APIG-导入微服务:请求参数

API网关 APIG-导入微服务:请求参数

时间：2024-11-11 18:22:32
API网关 APIG 专享版-微服务中心管理

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

group_info

是

MicroserviceGroup object

导入微服务的API分组信息

service_type

是

String

微服务中心类型。

  • CSE：CSE微服务注册中心

  • CCE: CCE云容器引擎（工作负载）

  • CCE_SERVICE: CCE云容器引擎（Service）

  • NACOS: Nacos注册中心，nacos_info必填。

protocol

否

String

API网关访问微服务的请求协议

  • HTTP

  • HTTPS

缺省值：HTTPS

apis

是

Array of MicroserviceApiCreate objects

导入的api列表

数组长度：1 - 50

backend_timeout

否

Integer

APIG请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000，默认5000

单位：毫秒。

最小值：1

缺省值：5000

auth_type

否

String

API的认证方式，默认无认证。

  • NONE：无认证

  • APP：APP认证

  • IAM：IAM认证

缺省值：NONE

cors

否

Boolean

是否支持跨域，默认不支持

  • true：支持

  • false：不支持

缺省值：false

cse_info

否

MicroServiceInfoCSECreate object

CSE微服务详细信息，service_type为CSE时必填

cce_info

否

MicroServiceInfoCCECreate object

CCE云容器引擎工作负载信息，service_type为CCE时必填

cce_service_info

否

MicroServiceInfoCCEServiceCreate object

CCE云容器引擎Service信息，service_type为CCE_SERVICE时必填

nacos_info

否

MicroServiceInfoNacosBase object

nacos基础信息。
表4 MicroserviceGroup

参数

是否必选

参数类型

描述

group_id

否

String

指定已有的分组，为空时创建新的分组

最小长度：0

最大长度：64

group_name

否

String

API分组的名称,group_id为空时必填。

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

说明：

中文字符必须为UTF-8或者unicode编码。

最小长度：3

最大长度：255

app_id

否

String

group_id为空时必填，指定新分组所属的集成应用

最小长度：0

最大长度：64
表5 MicroserviceApiCreate

参数

是否必选

参数类型

描述

name

否

String

API名称。

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

说明：

中文字符必须为UTF-8或者unicode编码。

最小长度：3

最大长度：255

req_method

否

String

API的请求方式

缺省值：ANY

req_uri

是

String

请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ . 等特殊字符，总长度不超过512，且满足URI规范。

/apic/health_check为APIG预置的健康检查路径，当req_method=GET时不支持req_uri=/apic/health_check。

说明：

需要服从URI规范。

最小长度：1

最大长度：512

match_mode

否

String

API的匹配方式

  • SWA：前缀匹配

  • NORMAL：正常匹配（绝对匹配）

    默认：NORMAL

缺省值：SWA
表6 MicroServiceInfoCSECreate

参数

是否必选

参数类型

描述

engine_id

是

String

微服务引擎编号

最大长度：64

service_id

是

String

微服务编号

最大长度：64

version

是

String

微服务版本

最大长度：64
表7 MicroServiceInfoCCECreate

参数

是否必选

参数类型

描述

cluster_id

是

String

云容器引擎集群编号

最大长度：64

namespace

是

String

命名空间

最大长度：64

workload_type

是

String

工作负载类型

  • deployment：无状态负载

  • statefulset：有状态负载

  • daemonset：守护进程集

app_name

否

String

APP名称。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。

说明：

中文字符必须为UTF-8或者unicode编码。

最小长度：1

最大长度：64

label_key

否

String

服务标识名。支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号，且只能以英文、汉字和数字开头，1-64个字符。

说明：

中文字符必须为UTF-8或者unicode编码。

最小长度：1

最大长度：64

label_value

否

String

服务标识值。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。

说明：

中文字符必须为UTF-8或者unicode编码。

最小长度：1

最大长度：64

version

否

String

工作负载的版本

最大长度：64

port

是

Integer

工作负载的监听端口号

最小值：1

最大值：65535

labels

否

Array of MicroserviceLabel objects

工作负载的标签列表。
表8 MicroserviceLabel

参数

是否必选

参数类型

描述

label_name

是

String

标签名称。

以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。

最小长度：1

最大长度：63

label_value

是

String

标签值。

以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。

最小长度：1

最大长度：63
表9 MicroServiceInfoCCEServiceCreate

参数

是否必选

参数类型

描述

cluster_id

是

String

云容器引擎集群编号

最大长度：64

namespace

是

String

命名空间。1-63字符。只能包含小写字母、数字，以及 '-'，必须以字母开头，必须以字母数字结尾。

最小长度：1

最大长度：63

service_name

是

String

Service名称。支持汉字，英文，数字，点，中划线，下划线，且只能以英文和汉字开头，1-64字符。

说明：

中文字符必须为UTF-8或者unicode编码。

最小长度：1

最大长度：64

port

否

Integer

Service的监听端口号。如果是多端口Service，用户需填写一个端口。

最小值：1

最大值：65535
表10 MicroServiceInfoNacosBase

参数

是否必选

参数类型

描述

namespace

否

String

命名空间ID，当选择默认命名空间public时，此项为空。由字母、数字、连接符('-')、下划线('_')组成且64个字符之内。

最小长度：0

最大长度：64

cluster_name

否

String

集群名称，默认为DEFAULT。由字母、数字、连接符('-')、下划线('_')组成且64个字符之内。

最小长度：0

最大长度：64

group_name

否

String

分组名称，默认为DEFAULT_GROUP。由字母、数字、连接符('-')、下划线('_')、点号('.')、冒号(':')组成且128个字符之内。

最小长度：0

最大长度：128

service_name

是

String

微服务名称。不包含中文和@@，不得以@开头，512个字符以内。

最小长度：1

最大长度：512

server_config

是

Array of NacosServerConfig objects

nacos服务端配置信息。

数组长度：1 - 9

user_info

是

NacosUserInfo object

nacos用户信息。
表11 NacosServerConfig

参数

是否必选

参数类型

描述

ip_address

是

String

nacos服务端IP地址。不包含中文字符。

最小长度：7

最大长度：128

port

是

Integer

nacos服务端端口号。取值范围1 ~ 65535。

最小值：1

最大值：65535

grpc_port

否

Integer

nacos服务端gRPC端口号，默认为port+1000。取值范围1 ~ 65535。

最小值：1

最大值：65535
表12 NacosUserInfo

参数

是否必选

参数类型

描述

user_name

是

String

nacos用户名。

最小长度：1

最大长度：64

password

是

String

nacos密码。

最小长度：1

最大长度：64
support.huaweicloud.com/api-apig/ImportMicroservice.html

华为云11.11 2核1G 2M 云服务器

29元/年

立即注册 领万元上云礼券

抽奖赢11111元免单

续费同价 L实例 2核2G 4M

98元/年

热门域名 1元 随心购

1元/年

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

搜索反馈

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

是的 没有

意见反馈

0/200

提交 取消

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