DocsICP FilingConsole
官方文档
首页

HttpApiDeployConfig

更新时间：
复制 MD 格式
产品详情
我的收藏

Parameter

Type

Description

Example

object

The AI API configuration.

environmentId

string

The environment ID.

env-xxx
backendScene

string

The backend deployment scenario.

SingleService
autoDeploy

boolean

Specifies whether to enable automatic deployment.

true
gatewayId

string

The gateway instance ID.

gw-xx
routeBackend Backend

The backend service configuration.

gatewayInfo GatewayInfo

The gateway information.

mock HttpApiMockContract

The mock configuration.

gatewayType

string

The gateway type.

API
customDomainIds

array

A list of custom domain IDs.

string

The domain ID.

d-xxx
envDomainIds

array

string

d-xxx
serviceConfigs

array

A list of service configurations.

object

A service configuration.

serviceId

string

The service ID.

svc-xxx
weight

integer

The service weight.

100
modelNamePattern

string

The model name pattern.

qwen-*
modelName

string

The model name.

qwen-max
intentCode

string

The intent code.

INQUIRY
match HttpApiBackendMatchConditions

The match conditions.

port

integer

The service port.

80
protocol

string

The service protocol. Valid values: HTTP, HTTPS.

HTTP
gatewayServiceId

string

The gateway service ID.

gw-svc-abc123
name

string

The service display name.

Qwen-Max-Service
version

string

The service version tag.

V2
multiServiceRouteStrategy

string

The multi-service routing strategy type.

ByWeight
observabilityRouteConfig

object

The observability routing configuration.

mode

string

The routing mode.

LeastBusy
rateLimit

number

The maximum traffic ratio for a single service.

0.8
queueSize

integer

The queue size.

100
policyConfigs

array

A list of policy configurations.

object

A policy configuration.

type

string

The policy type.

AiFallback
enable

boolean

Specifies whether the policy is enabled.

true
aiFallbackConfig

object

The AiFallback policy configuration.

serviceConfigs

array

A list of service configurations.

object

A service configuration.

serviceId

string

The service ID.

svc-******
targetModelName

string

The target model name.

gpt-4/llama3-70b
aiSecurityGuardConfig

object

The AI security guard configuration.

serviceAddress

string

The address of the backend service.

https://api.example.com/v1
checkRequest

boolean

Specifies whether to enable request validation.

true
checkResponse

boolean

Specifies whether to enable response validation.

true
checkRequestImage

boolean

Specifies whether to enable validation for image content in requests.

true
checkResponseImage

boolean

Specifies whether to enable validation for image content in responses.

true
requestCheckService

string

The address of the external service for request validation.

https://checker.example.com/validate-request
responseCheckService

string

The address of the external service for response validation.

https://checker.example.com/validate-response
requestImageCheckService

string

The address of the external service for validating image content in requests.

https://image-checker.example.com/scan
responseImageCheckService

string

The address of the external service for validating image content in responses.

https://image-checker.example.com/scan-response
riskAlertLevel

string

The risk alert level.

low/medium/high
riskConfig

array

The risk configuration.

object

A risk configuration item.

type

string

The type of risk.

K8S
level

string

The risk level. Valid values:

  • Critical

  • Warning

  • Informational

Critical
consumerRules

object

The consumer-specific rule.

pattern

string

The pattern to match. The interpretation of the pattern depends on the matchType.

first
matchType

string

The query match type. Valid values:

  • term: Exact match.

  • regex: Regular expression match.

  • phrase: Phrase match (default).

  • wildcard: Wildcard match.

term
bufferLimit

integer

The buffer size limit, in bytes.

50
consumerRequestCheckService

array

A list of consumer request validation services.

object

name

string

The name of the validation rule.

API
requestCheckService

string

The address of the request validation service.

https://checker.example.com/validate
requestImageCheckService

string

The address of the request image validation service.

https://image-check.example.com/scan
matchType

string

The match type.

exact/prefix
modalityType

string

The modality type.

text/image
consumerResponseCheckService

array

A list of consumer response validation services.

object

name

string

The name of the validation rule.

AI_API
responseCheckService

string

The address of the response validation service.

https://checker.example.com/validate-response
responseImageCheckService

string

The address of the response image validation service.

https://image-check.example.com/scan-response
matchType

string

The query match type. Valid values:

  • term: Exact match.

  • regex: Regular expression match.

  • phrase: Phrase match (default).

  • wildcard: Wildcard match.

term
modalityType

string

The modality type.

text/image
consumerRiskLevel

array

A list of consumer-specific risk level configurations.

object

name

string

The name of the consumer.

APIG-UI
matchType

string

The query match type. Valid values:

  • term: Exact match.

  • regex: Regular expression match.

  • phrase: Phrase match (default).

  • wildcard: Wildcard match.

term
type

string

The type of consumer or rule.

K8S
level

string

The risk level. Valid values:

  • Critical

  • Warning

  • Informational

Critical
aiTokenRateLimitConfig

object

The AI token rate limit configuration.

rules

array

A list of rate limiting rules.

object

A rate limiting rule.

limitType

string

The rate limit type.

request/token
matchKey

string

The match key.

user_id/api_path
matchType

string

The query match type. Valid values:

  • term: Exact match.

  • regex: Regular expression match.

  • phrase: Phrase match (default).

  • wildcard: Wildcard match.

term
matchValue

string

The match value.

user123
limitMode

string

The rate limit mode.

local
limitValue

integer

The rate limit value.

100
globalRules

array

The global rate limiting rules.

object

A global rate limiting rule.

limitType

string

The rate limit type.

request
matchKey

string

The match key.

user_id
matchType

string

The query match type. Valid values:

  • term: Exact match.

  • regex: Regular expression match.

  • phrase: Phrase match (default).

  • wildcard: Wildcard match.

term
matchValue

string

The match value.

user123
limitMode

string

The rate limit mode.

local
limitValue

integer

The rate limit value.

100
enableGlobalRules

boolean

Specifies whether to enable global rules.

true
aiStatisticsConfig

object

logRequestContent

boolean

logResponseContent

boolean

customDomainInfos

array

A list of custom domain details.

object

A custom domain detail.

domainId

string

The domain ID.

d-cshee6dlhtgk******
name

string

The domain name.

hello-server.com
protocol

string

The protocol.

HTTP
envDomainInfos

array

object

domainId

string

name

string

protocol

string

subDomains

array

Subdomain content list.

object

Network type.

domainId

string

Domain ID.

d-csmn42um******
name

string

Domain name.

test
protocol

string

Protocol.

HTTP
networkType

string

Network type.

Intranet
builtinRouteNames

array

string