Skip to content

HttpApiProps

Properties for defining a HttpApi.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-httpapi

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkapig"
&alicloudroscdkapig.HttpApiProps {
    HttpApiName: interface{},
    AgentProtocols: interface{},
    AiProtocols: interface{},
    AuthConfig: interface{},
    BasePath: interface{},
    BelongGatewayId: interface{},
    BuiltinRouteNames: interface{},
    DeployConfigs: interface{},
    Description: interface{},
    EnableAuth: interface{},
    FirstByteTimeout: interface{},
    IngressConfig: interface{},
    ModelCategory: interface{},
    OnlyChangeConfig: interface{},
    Protocols: interface{},
    RemoveBasePathOnForward: interface{},
    ResourceGroupId: interface{},
    Strategy: interface{},
    Type: interface{},
    VersionConfig: interface{},
}

Properties

Name Type Description
HttpApiName interface{} Property httpApiName: The name of the HTTP API.
AgentProtocols interface{} Property agentProtocols: The agent protocols of the HTTP API.
AiProtocols interface{} Property aiProtocols: The AI protocols of the HTTP API.
AuthConfig interface{} Property authConfig: The authentication configuration.
BasePath interface{} Property basePath: The base path of the HTTP API.
BelongGatewayId interface{} Property belongGatewayId: The gateway ID that the HTTP API belongs to.
BuiltinRouteNames interface{} Property builtinRouteNames: The builtin route names.
DeployConfigs interface{} Property deployConfigs: The deploy configurations of the HTTP API.
Description interface{} Property description: The description of the HTTP API.
EnableAuth interface{} Property enableAuth: Whether to enable authentication.
FirstByteTimeout interface{} Property firstByteTimeout: The first byte timeout.
IngressConfig interface{} Property ingressConfig: The ingress configuration of the HTTP API.
ModelCategory interface{} Property modelCategory: The model category.
OnlyChangeConfig interface{} Property onlyChangeConfig: Whether to only change config without triggering redeployment.
Protocols interface{} Property protocols: The protocols supported by the HTTP API.
RemoveBasePathOnForward interface{} Property removeBasePathOnForward: Whether to remove the base path on forward.
ResourceGroupId interface{} Property resourceGroupId: The ID of the resource group.
Strategy interface{} Property strategy: The strategy of the HTTP API.
Type interface{} Property type: The type of the HTTP API.
VersionConfig interface{} Property versionConfig: The version configuration of the HTTP API.

HttpApiNameRequired

HttpApiName interface{}
  • Type: interface{}

Property httpApiName: The name of the HTTP API.


AgentProtocolsOptional

AgentProtocols interface{}
  • Type: interface{}

Property agentProtocols: The agent protocols of the HTTP API.


AiProtocolsOptional

AiProtocols interface{}
  • Type: interface{}

Property aiProtocols: The AI protocols of the HTTP API.


AuthConfigOptional

AuthConfig interface{}
  • Type: interface{}

Property authConfig: The authentication configuration.


BasePathOptional

BasePath interface{}
  • Type: interface{}

Property basePath: The base path of the HTTP API.


BelongGatewayIdOptional

BelongGatewayId interface{}
  • Type: interface{}

Property belongGatewayId: The gateway ID that the HTTP API belongs to.


BuiltinRouteNamesOptional

BuiltinRouteNames interface{}
  • Type: interface{}

Property builtinRouteNames: The builtin route names.


DeployConfigsOptional

DeployConfigs interface{}
  • Type: interface{}

Property deployConfigs: The deploy configurations of the HTTP API.


DescriptionOptional

Description interface{}
  • Type: interface{}

Property description: The description of the HTTP API.


EnableAuthOptional

EnableAuth interface{}
  • Type: interface{}

Property enableAuth: Whether to enable authentication.


FirstByteTimeoutOptional

FirstByteTimeout interface{}
  • Type: interface{}

Property firstByteTimeout: The first byte timeout.


IngressConfigOptional

IngressConfig interface{}
  • Type: interface{}

Property ingressConfig: The ingress configuration of the HTTP API.


ModelCategoryOptional

ModelCategory interface{}
  • Type: interface{}

Property modelCategory: The model category.


OnlyChangeConfigOptional

OnlyChangeConfig interface{}
  • Type: interface{}

Property onlyChangeConfig: Whether to only change config without triggering redeployment.

True means only modify configuration without triggering redeployment.


ProtocolsOptional

Protocols interface{}
  • Type: interface{}

Property protocols: The protocols supported by the HTTP API.


RemoveBasePathOnForwardOptional

RemoveBasePathOnForward interface{}
  • Type: interface{}

Property removeBasePathOnForward: Whether to remove the base path on forward.


ResourceGroupIdOptional

ResourceGroupId interface{}
  • Type: interface{}

Property resourceGroupId: The ID of the resource group.


StrategyOptional

Strategy interface{}
  • Type: interface{}

Property strategy: The strategy of the HTTP API.


TypeOptional

Type interface{}
  • Type: interface{}

Property type: The type of the HTTP API.


VersionConfigOptional

VersionConfig interface{}
  • Type: interface{}

Property versionConfig: The version configuration of the HTTP API.