All Products
Search

This Product

    API Gateway:HttpApiDeployConfig

    Document Center

    API Gateway:HttpApiDeployConfig

    Last Updated:Mar 31, 2026

    Parameter

    Type

    Description

    Example

    object

    The AI API configuration.

    environmentId

    string

    The environment ID.

    env-xxx
    backendScene

    string

    The deployment scenario.

    SingleService
    autoDeploy

    boolean

    Whether to enable auto deployment.

    true
    gatewayId

    string

    The gateway instance ID.

    gw-xx
    routeBackend Backend

    The backend service information.

    gatewayInfo GatewayInfo

    The gateway information.

    mock HttpApiMockContract

    The mock configuration.

    gatewayType

    string

    The gateway type.

    API
    customDomainIds

    array

    A list of custom domain name IDs.

    string

    The domain name ID.

    d-xxx
    serviceConfigs

    array

    A list of service configurations.

    object

    An existing service configuration.

    serviceId

    string

    The service ID.

    svc-xxx
    weight

    integer

    The service weight.

    100
    modelNamePattern

    string

    The model name matching rule.

    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 and HTTPS.

    HTTP
    gatewayServiceId

    string

    The gateway service ID.

    gw-svc-abc123
    name

    string

    The display name of the service.

    Qwen-Max-Service
    version

    string

    The service version tag.

    V2
    multiServiceRouteStrategy

    string

    The multi-service routing strategy.

    ByWeight
    observabilityRouteConfig

    object

    The observability-based routing configuration.

    mode

    string

    The routing mode.

    LeastBusy
    rateLimit

    number

    The maximum traffic percentage 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

    Whether the policy is enabled.

    true
    aiFallbackConfig

    object

    The AI fallback 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

    Whether to enable request check.

    true
    checkResponse

    boolean

    Whether to enable response check.

    true
    checkRequestImage

    boolean

    Whether to check image content in requests.

    true
    checkResponseImage

    boolean

    Whether to check image content in responses.

    true
    requestCheckService

    string

    The address of the external service that checks requests.

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

    string

    The address of the external service that checks responses.

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

    string

    The address of the external service that checks image content in requests.

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

    string

    The address of the external service that checks image content in responses.

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

    string

    The risk level of content or behavior that triggers an alert.

    low/medium/high
    riskConfig

    array

    The risk configuration rules.

    object

    A risk configuration rule.

    type

    string

    The policy type.

    K8S
    level

    string

    The risk level. Valid values:

    • Critical

    • Warning

    • Informational

    Critical
    consumerRules

    object

    The consumer rules.

    pattern

    string

    The pattern to match for the consumer rule.

    first
    matchType

    string

    The query match type. Valid values:

    • term: Exact match.

    • regex: Regular expression match.

    • phrase: Phrase match. This is the default type.

    • wildcard: Wildcard match.

    term
    bufferLimit

    integer

    The maximum buffer size, in bytes.

    50
    consumerRequestCheckService

    array

    The consumer request check service.

    object

    A consumer request check service configuration.

    name

    string

    The name.

    API
    requestCheckService

    string

    The request check service.

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

    string

    The request image check service.

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

    string

    The match type.

    exact/prefix
    modalityType

    string

    The modality type.

    text/image
    consumerResponseCheckService

    array

    The consumer response check service.

    object

    A consumer response check service configuration.

    name

    string

    The name.

    AI_API
    responseCheckService

    string

    The response check service.

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

    string

    The response image check 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. This is the default type.

    • wildcard: Wildcard match.

    term
    modalityType

    string

    The modality type.

    text/image
    consumerRiskLevel

    array

    The consumer risk level.

    object

    A consumer risk level configuration.

    name

    string

    The parameter name.

    APIG-UI
    matchType

    string

    The query match type. Valid values:

    • term: Exact match.

    • regex: Regular expression match.

    • phrase: Phrase match. This is the default type.

    • wildcard: Wildcard match.

    term
    type

    string

    The type of the 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 validation or processing rules.

    object

    A validation or processing 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. This is the default type.

    • 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 rules.

    object

    A global 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. This is the default type.

    • 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

    Whether to enable global rules.

    true
    aiStatisticsConfig

    object

    The AI statistics configuration.

    logRequestContent

    boolean

    Whether to log request content.

    logResponseContent

    boolean

    Whether to log response content.

    customDomainInfos

    array

    A list of custom domain name information.

    object

    Information about a custom domain name.

    domainId

    string

    The domain name ID.

    d-cshee6dlhtgk******
    name

    string

    The domain name.

    hello-server.com
    protocol

    string

    The protocol.

    HTTP
    subDomains

    array

    A list of subdomains.

    object

    A subdomain.

    domainId

    string

    The domain ID.

    d-csmn42um******
    name

    string

    The domain name.

    test
    protocol

    string

    The protocol.

    HTTP
    networkType

    string

    The network type.

    Intranet