HttpApiApiInfo

名称类型描述示例值
object

API 信息。

httpApiIdstring

HTTP API ID。

api-xxx
namestring

API 名称。

test
protocolsarray

API 协议列表。

string

协议。

枚举值:
  • HTTPSHTTPS
  • HTTPHTTP
HTTP
basePathstring

API 基础路径。

/v1
descriptionstring

API 描述。

测试专用API
versionInfoHttpApiVersionInfo

API 版本控制信息。

environmentsarray<object>

API 的发布环境信息。

object

单个环境信息。

environmentIdstring

环境 ID。

env-xxx
backendScenestring

发布场景。

枚举值:
  • SingleService单服务
  • MultiServiceByRatio按比例
  • MultiServiceByContent按内容
  • MultiServiceByTag按标签
  • MockMock
SingleService
backendTypestring

后端类型。

枚举值:
  • DNSDNS域名
  • Service已有服务
  • VIP固定地址
  • CloudProduct云产品配置
Service
serviceConfigsarray<object>

已有服务配置。

object
gatewayServiceIdstring

服务 ID。

gs-xxx
namestring

服务名

demo-service
protocolstring

协议

HTTP
portstring

服务端口。

8080
weightinteger

权重。

100
versionstring

服务版本。

v1
matchHttpApiBackendMatchConditions

匹配条件。

serviceIdstring

服务 ID。

svc-xxx
customDomainsarray

用户发布的域名信息。

HttpApiDomainInfo

域名信息。

namestring

环境名称。

test
aliasstring

环境别名。

test
gatewayInfoobject

当前环境所属网关实例信息。

gatewayIdstring

网关实例 ID。

gw-xxx
namestring

网关实例名称。

test
deployStatusstring

API 在当前环境的发布状态

Deployed
subDomainsarray<object>

环境默认域名列表。

object
domainIdstring

域名 ID。

d-xxx
namestring

域名。

www.example.com
protocolstring

访问协议。

HTTP
networkTypestring

网络类型。

Internet
ingressInfoobject

Http Ingress Api 的信息。

sourceIdstring

来源 ID。

src-xxx
ingressClassstring

监听的 Ingress Class

mse
watchNamespacestring

监听的命名空间。

default
environmentInfoobject

环境信息。

environmentIdstring

环境 ID。

env-xxx
k8sClusterInfoobject

k8s 集群信息。

clusterIdstring

集群 ID。

ca435c77cba1547cca9311957bcxxxxxx
overrideIngressIpboolean

是否更新 Ingress Status 里的地址

true
typestring

API 类型。

枚举值:
  • HttpIngressHttpIngress
  • RestRest
  • WebsocketWebsocket
  • AIAI
  • HttpHttp
Rest
resourceGroupIdstring

资源组 ID

rg-xxx
aiProtocolsarray

AI 协议列表。

string

AI 协议。

枚举值:
  • OpenAI/v1OpenAI/v1
OpenAI/v1
deployConfigsarray

API 部署配置列表。

HttpApiDeployConfig

API 部署配置。