| Parameter | Type | Description | Example |
|---|---|---|---|
| object | The API information. | ||
| httpApiId | string | The HTTP API ID. | api-xxx |
| name | string | The API name. | test |
| protocols | array | The protocols. | |
| string | The protocol. Valid values:
| HTTP | |
| basePath | string | The base path of the API. | /v1 |
| description | string | The API description. | for test only |
| versionInfo | HttpApiVersionInfo | The API versioning information. | |
| environments | array<object> | The API environment information. | |
| object | The information about an environment. | ||
| environmentId | string | The environment ID. | env-xxx |
| backendScene | string | The publishing scenario. Valid values:
| SingleService |
| backendType | string | The type of the backend service. Valid values:
| Service |
| serviceConfigs | array<object> | The configurations of an existing service. | |
| object | |||
| gatewayServiceId | string | The service ID. | gs-xxx |
| name | string | The service name. | demo-service |
| protocol | string | The protocol. | HTTP |
| port | string | The service port. | 8080 |
| weight | integer | The service weight. | 100 |
| version | string | The service version. | v1 |
| match | HttpApiBackendMatchConditions | The matching conditions. | |
| serviceId | string | The service ID. | svc-xxx |
| customDomains | array | The custom domain names. | |
| HttpApiDomainInfo | The domain name information. | ||
| name | string | The environment name. | test |
| alias | string | The environment alias. | test |
| gatewayInfo | object | The information about the gateway instance to which the environment belongs. | |
| gatewayId | string | The instance ID. | gw-xxx |
| name | string | The instance name. | test |
| deployStatus | string | The publishing status of the API in the current environment. | Deployed |
| subDomains | array<object> | The default domain names of the environment. | |
| object | |||
| domainId | string | The domain name ID. | d-xxx |
| name | string | The domain name. | www.example.com |
| protocol | string | The communication protocol. | HTTP |
| networkType | string | The network type. | Internet |
| ingressInfo | object | The information about the HTTP Ingress API. | |
| sourceId | string | The source ID. | src-xxx |
| ingressClass | string | The Ingress Class for listening. | mse |
| watchNamespace | string | The namespace for listening. | default |
| environmentInfo | object | The environment information. | |
| environmentId | string | The environment ID. | env-xxx |
| k8sClusterInfo | object | The information about the Kubernetes cluster. | |
| clusterId | string | The cluster ID. | ca435c77cba1547cca9311957bcxxxxxx |
| overrideIngressIp | boolean | Specifies whether to update the address in Ingress Status. | true |
| type | string | The API type. Valid values:
| Rest |
| resourceGroupId | string | The resource group ID. | rg-xxx |
| aiProtocols | array | The AI protocols. | |
| string | The AI protocol. Valid values:
| OpenAI/v1 | |
| deployConfigs | array | The API deployment configurations. | |
| HttpApiDeployConfig | The API deployment configuration. | ||
| enabelAuth | boolean | Specifies whether to enable authentication. | |
| authConfig | AuthConfig | The authentication configurations. |