Skip to content

HttpApiProps

Properties for defining a HttpApi.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Apig;
new HttpApiProps {
    object HttpApiName,
    object AgentProtocols = null,
    object AiProtocols = null,
    object AuthConfig = null,
    object BasePath = null,
    object BelongGatewayId = null,
    object BuiltinRouteNames = null,
    object DeployConfigs = null,
    object Description = null,
    object EnableAuth = null,
    object FirstByteTimeout = null,
    object IngressConfig = null,
    object ModelCategory = null,
    object OnlyChangeConfig = null,
    object Protocols = null,
    object RemoveBasePathOnForward = null,
    object ResourceGroupId = null,
    object Strategy = null,
    object Type = null,
    object VersionConfig = null
};

Properties

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

HttpApiNameRequired

public object HttpApiName { get; set; }
  • Type: object

Property httpApiName: The name of the HTTP API.


AgentProtocolsOptional

public object AgentProtocols { get; set; }
  • Type: object

Property agentProtocols: The agent protocols of the HTTP API.


AiProtocolsOptional

public object AiProtocols { get; set; }
  • Type: object

Property aiProtocols: The AI protocols of the HTTP API.


AuthConfigOptional

public object AuthConfig { get; set; }
  • Type: object

Property authConfig: The authentication configuration.


BasePathOptional

public object BasePath { get; set; }
  • Type: object

Property basePath: The base path of the HTTP API.


BelongGatewayIdOptional

public object BelongGatewayId { get; set; }
  • Type: object

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


BuiltinRouteNamesOptional

public object BuiltinRouteNames { get; set; }
  • Type: object

Property builtinRouteNames: The builtin route names.


DeployConfigsOptional

public object DeployConfigs { get; set; }
  • Type: object

Property deployConfigs: The deploy configurations of the HTTP API.


DescriptionOptional

public object Description { get; set; }
  • Type: object

Property description: The description of the HTTP API.


EnableAuthOptional

public object EnableAuth { get; set; }
  • Type: object

Property enableAuth: Whether to enable authentication.


FirstByteTimeoutOptional

public object FirstByteTimeout { get; set; }
  • Type: object

Property firstByteTimeout: The first byte timeout.


IngressConfigOptional

public object IngressConfig { get; set; }
  • Type: object

Property ingressConfig: The ingress configuration of the HTTP API.


ModelCategoryOptional

public object ModelCategory { get; set; }
  • Type: object

Property modelCategory: The model category.


OnlyChangeConfigOptional

public object OnlyChangeConfig { get; set; }
  • Type: object

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

True means only modify configuration without triggering redeployment.


ProtocolsOptional

public object Protocols { get; set; }
  • Type: object

Property protocols: The protocols supported by the HTTP API.


RemoveBasePathOnForwardOptional

public object RemoveBasePathOnForward { get; set; }
  • Type: object

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


ResourceGroupIdOptional

public object ResourceGroupId { get; set; }
  • Type: object

Property resourceGroupId: The ID of the resource group.


StrategyOptional

public object Strategy { get; set; }
  • Type: object

Property strategy: The strategy of the HTTP API.


TypeOptional

public object Type { get; set; }
  • Type: object

Property type: The type of the HTTP API.


VersionConfigOptional

public object VersionConfig { get; set; }
  • Type: object

Property versionConfig: The version configuration of the HTTP API.