Cloud-native gateway traffic throttling plugin parameter throttling precise Qps threshold
Used by actions: CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit.
| Name | Type | Required | Description |
|---|---|---|---|
| Unit | String | Yes | qps threshold control dimension, including: second, minute, hour, day, month, year. |
| GlobalConfigId | String | Yes | Global configuration ID |
Routing rule request from source service configuration detail
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | Type. Note: This field may return null, indicating that no valid values can be obtained. |
| Key | String | No | Key value Note: This field may return null, indicating that no valid values can be obtained. |
| Value | ArgumentValue | No | Matching condition parameter Note: This field may return null, indicating that no valid values can be obtained. |
Called service configuration expression
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | expression type Note: This field may return null, indicating that no valid values can be obtained. |
| Value | String | Yes | Match Value Note: This field may return null, indicating that no valid values can be obtained. |
| ValueType | String | Yes | value type Note: This field may return null, indicating that no valid values can be obtained. |
Metric scaling behavior
Used by actions: CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy.
| Name | Type | Required | Description |
|---|---|---|---|
| ScaleUp | AutoScalerRules | No | Scale-out behavior configuration |
| ScaleDown | AutoScalerRules | No | Behavior configuration for scale-in |
Scaling policy
Used by actions: CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | Type, Pods |
| Value | Integer | No | Quantity. |
| PeriodSeconds | Integer | No | Expansion cycle |
Metric scaling rule
Used by actions: CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy.
| Name | Type | Required | Description |
|---|---|---|---|
| StabilizationWindowSeconds | Integer | No | Stability window time. Default is 0 during scaling and 300 during descaling. |
| SelectPolicy | String | No | Selection policy basis |
| Policies | Array of AutoScalerPolicy | No | Scaling policy |
Grayscale Rule Priority - Rule
Used by actions: ModifyCloudNativeAPIGatewayCanaryRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Priority | Integer | No | Priority |
| CanaryRule | CloudNativeAPIGatewayCanaryRule | No | Grayscale rule configuration |
Certificate information
Used by actions: CreateCloudNativeAPIGatewayCertificate.
| Name | Type | Description |
|---|---|---|
| Id | String | Unique ID |
Grayscale rule list.
Used by actions: DescribeCloudNativeAPIGatewayCanaryRules.
| Name | Type | Description |
|---|---|---|
| CanaryRuleList | Array of CloudNativeAPIGatewayCanaryRule | Grayscale rule |
| TotalCount | Integer | Total number. |
Service with percentage traffic configuration
Used by actions: CreateCloudNativeAPIGatewayCanaryRule, ModifyCloudNativeAPIGatewayCanaryRule.
| Name | Type | Required | Description |
|---|---|---|---|
| ServiceID | String | No | Service ID, required as an input parameter |
| ServiceName | String | No | Service name, as an input parameter, meaningless |
| UpstreamName | String | No | Upstream name, meaningless as an input parameter |
| Percent | Float | No | Percentage, 10 means 10%, range 0-100 |
Grayscale rule
Used by actions: CreateCloudNativeAPIGatewayCanaryRule, DescribeCloudNativeAPIGatewayCanaryRules, ModifyCloudNativeAPIGatewayCanaryRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Priority | Integer | Yes | Priority, with a range of 0 to 100. A larger value indicates a higher priority. Priorities must be unique across different rules. |
| Enabled | Boolean | Yes | Whether the rule is enabled. |
| ConditionList | Array of CloudNativeAPIGatewayCanaryRuleCondition | No | Match condition parameter |
| BalancedServiceList | Array of CloudNativeAPIGatewayBalancedService | No | Traffic percentage configuration of the service Note: This field may return null, indicating that no valid values can be obtained. |
| ServiceId | String | No | service ID |
| ServiceName | String | No | Service name |
| RuleType | String | No | Grayscale rule type Standard｜Lane |
| MatchType | String | No | Full-link grayscale policy match mode between multiple conditions: AND, OR |
| GroupId | String | No | Lane group ID |
| GroupName | String | No | Lane group name |
| LaneId | String | No | Lane ID |
| LaneName | String | No | swimlane name |
| MatchMode | String | No | Lane match rule: STRICT |
| LaneTag | String | No | Lane tag |
Condition configuration in grayscale rule
Used by actions: CreateCloudNativeAPIGatewayCanaryRule, ModifyCloudNativeAPIGatewayCanaryRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Condition type, support path, method, query, header, cookie, body, and system. |
| Key | String | No | Parameter name. |
| Operator | String | No | Operator, supports "le", "eq", "lt", "ne", "ge", "gt", "regex", "exists", "in", "not in", "prefix", "exact", "regex" |
| Value | String | No | Target parameter value |
| Delimiter | String | No | Separator. This parameter is valid only when Operator is in or not in. Supported values: comma, semicolon, space, line break. |
| GlobalConfigId | String | No | Global configuration Id |
| GlobalConfigName | String | No | Global configuration name |
Cloud native API gateway configuration message.
Used by actions: DescribeCloudNativeAPIGatewayConfig, DescribePublicNetwork.
| Name | Type | Description |
|---|---|---|
| ConsoleType | String | Console type. |
| HttpUrl | String | HTTP URL. |
| HttpsUrl | String | HTTPS URL. |
| NetType | String | Network type, Open |
| AdminUser | String | Admin username. |
| AdminPassword | String | Administrator password. |
| Status | String | Network Status, Open |
| AccessControl | NetworkAccessControl | Network access policy Note: This field may return null, indicating that no valid values can be obtained. |
| SubnetId | String | Intranet subnet ID |
| VpcId | String | Private network VPC ID |
| Description | String | Description of load balancing |
| SlaType | String | Load balancing specification type |
| SlaName | String | clb specification name |
| Vip | String | clb vip |
| InternetMaxBandwidthOut | Integer | Bandwidth |
| MultiZoneFlag | Boolean | Whether the multiple-AZ deployment mode is used. |
| MasterZoneId | String | Primary AZ. |
| SlaveZoneId | String | standby availability zone |
| MasterZoneName | String | Primary availability zone name |
| SlaveZoneName | String | Backup availability zone name |
| NetworkId | String | Network id |
| IPV6FullChain | Boolean | Whether the CLB is a new ipv6 CLB |
| CustomizedConfigContent | String | Load balancing personalized configuration content |
Cloud Native API Gateway Node Information.
Used by actions: DescribeCloudNativeAPIGatewayNodes.
| Name | Type | Description |
|---|---|---|
| NodeId | String | Cloud-native gateway node id |
| NodeIp | String | Node ip |
| ZoneId | String | Zone id |
| Zone | String | Zone |
| GroupId | String | group ID |
| GroupName | String | Group name |
| Status | String | Status. |
| Weight | Integer | Node weight |
| IsDefaultWeight | Boolean | Default weight required or not |
Cloud Native API gateway node configuration.
Used by actions: CreateCloudNativeAPIGateway, CreateNativeGatewayServerGroup, DescribeAutoScalerResourceStrategyBindingGroups, DescribeCloudNativeAPIGateway, DescribeNativeGatewayServerGroups, UpdateCloudNativeAPIGatewaySpec.
| Name | Type | Required | Description |
|---|---|---|---|
| Specification | String | Yes | Node configuration, 1c2g |
| Number | Integer | Yes | Node count, 2-9. |
Cloud-native gateway Tse traffic throttling plugin configuration
Used by actions: CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Plug-in enable status |
| QpsThresholds | Array of QpsThreshold | No | qps threshold |
| Path | String | No | Request path that requires traffic control |
| Header | String | No | Request header Key for traffic control |
| LimitBy | String | No | Traffic throttling basis ip service consumer credential path header |
| ExternalRedis | ExternalRedis | No | external redis configuration |
| GlobalConfigId | String | No | redis configuration in global configuration |
| Policy | String | No | Counter policy local standalone default redis external redis |
| RateLimitResponse | RateLimitResponse | No | Response configuration, response policy is text |
| RateLimitResponseUrl | String | No | Request forwarding address |
| ResponseType | String | No | response policy url request forwarding Response configuration default mode: return directly. |
| HideClientHeaders | Boolean | No | Whether to hide the traffic throttling client response header |
| LineUpTime | Integer | No | queuing time |
| IsDelay | Boolean | No | Whether request queuing is enabled |
| BasicLimitQpsThresholds | Array of QpsThreshold | No | Basic throttling Note: This field may return null, indicating that no valid values can be obtained. |
| LimitRules | Array of LimitRule | No | Parameter throttling policy Note: This field may return null, indicating that no valid values can be obtained. |
Gateway instance policy
Used by actions: DescribeAutoScalerResourceStrategies, DescribeNativeGatewayServerGroups.
| Name | Type | Description |
|---|---|---|
| StrategyId | String | Policy ID |
| StrategyName | String | Policy name. |
| CreateTime | String | Creation time. |
| ModifyTime | String | Update time |
| Description | String | Policy description |
| Config | CloudNativeAPIGatewayStrategyAutoScalerConfig | Auto scaling configuration |
| GatewayId | String | Gateway instance ID |
| CronConfig | CloudNativeAPIGatewayStrategyCronScalerConfig | Scheduled scaling configuration |
Auto scaling policy
Used by actions: CreateAutoScalerResourceStrategy, DescribeAutoScalerResourceStrategies, ModifyAutoScalerResourceStrategy.
| Name | Type | Required | Description |
|---|---|---|---|
| MaxReplicas | Integer | No | Maximum number of replicas |
| Metrics | Array of CloudNativeAPIGatewayStrategyAutoScalerConfigMetric | No | Metric list Note: This field may return null, indicating that no valid values can be obtained. |
| Behavior | AutoScalerBehavior | No | Metric scaling behavior configuration Note: This field may return null, indicating that no valid values can be obtained. |
Auto scaling configuration metrics
Used by actions: CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | Metric Type - Resource |
| ResourceName | String | No | Metric resource name - cpu - memory |
| TargetType | String | No | Metric target type, currently only support percentage Utilization |
| TargetValue | Integer | No | Target value of the metric |
Gateway group information of policy binding
Used by actions: DescribeAutoScalerResourceStrategyBindingGroups.
| Name | Type | Description |
|---|---|---|
| GroupId | String | gateway group ID |
| NodeConfig | CloudNativeAPIGatewayNodeConfig | Node configuration |
| BindTime | String | Binding time |
| GroupName | String | gateway group name |
| Status | String | Binding status |
Scheduled scaling policy configuration
Used by actions: CreateAutoScalerResourceStrategy, DescribeAutoScalerResourceStrategies, ModifyAutoScalerResourceStrategy.
| Name | Type | Required | Description |
|---|---|---|---|
| Params | Array of CloudNativeAPIGatewayStrategyCronScalerConfigParam | No | Scheduled scaling configuration parameter list Note: This field may return null, indicating that no valid values can be obtained. |
Scheduled scaling configuration parameter
Used by actions: CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy.
| Name | Type | Required | Description |
|---|---|---|---|
| Period | String | No | Scheduled scaling period |
| StartAt | String | No | Start time of scheduled scaling |
| TargetReplicas | Integer | No | Scheduled scaling target node count, no more than the maximum node count defined in metric scaling |
| Crontab | String | No | Scheduled scaling cron expression, no need to input |
Cloud native API gateway vpc configuration.
Used by actions: CreateCloudNativeAPIGateway, DescribeCloudNativeAPIGateway.
| Name | Type | Required | Description |
|---|---|---|---|
| VpcId | String | No | VPC ID. |
| SubnetId | String | No | Subnet ID. |
Create the cloud native API gateway response result.
Used by actions: CreateCloudNativeAPIGateway.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Cloud Native API Gateway ID. |
| Status | String | Cloud-native gateway status. |
| TaskId | String | Task ID. |
Create Gateway Group Information
Used by actions: CreateNativeGatewayServerGroup.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Gateway instance ID |
| GroupId | String | Group ID |
| Status | String | Status. |
| TaskId | String | Task ID. |
Cloud-native gateway service creation result
Used by actions: CreateCloudNativeAPIGatewayService.
| Name | Type | Description |
|---|---|---|
| ServiceId | String | Gateway Service ID |
Create a public network result for the kong client
Used by actions: CreateCloudNativeAPIGatewayPublicNetwork.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Gateway instance ID |
| GroupId | String | group ID |
| NetworkId | String | Client public network ID |
Delete the response result of the cloud native API gateway.
Used by actions: DeleteCloudNativeAPIGateway.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Cloud-native gateway ID. |
| Status | String | Cloud-native gateway status. |
Lane group
Used by actions: DeleteGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | lane name Note: This field may return null, indicating that no valid values can be obtained. |
| ID | String | No | Lane group ID Note: This field may return null, indicating that no valid values can be obtained. |
| TrafficEntries | Array of LaneTrafficEntry | No | Lane entry service list Note: This field may return null, indicating that no valid values can be obtained. |
| Destinations | Array of GovernanceServiceDestination | No | Lane service list Note: This field may return null, indicating that no valid values can be obtained. |
| Description | String | No | Lane group description Note: This field may return null, indicating that no valid values can be obtained. |
| Revision | String | No | Rule content summary Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | No | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| ModifyTime | String | No | Modification time. Note: This field may return null, indicating that no valid values can be obtained. |
| Consistency | String | No | Rule consistency status Note: This field may return null, indicating that no valid values can be obtained. |
| Rules | Array of GovernanceLaneRule | No | Lane rule list Note: This field may return null, indicating that no valid values can be obtained. |
Delete gateway instance result
Used by actions: DeleteNativeGatewayServerGroup.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Gateway instance ID |
| GroupId | String | Gateway group id |
| Status | String | deleted |
| TaskId | String | Task ID. |
Retrieve the configuration result of the cloud native API gateway instance network.
Used by actions: DescribeCloudNativeAPIGatewayConfig.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Gateway Instance ID |
| ConfigList | Array of CloudNativeAPIGatewayConfig | Grouped network configuration list. |
| GroupSubnetId | String | Grouped subnet info |
| GroupVpcId | String | Grouped VPC info |
| GroupId | String | group ID |
Obtain gateway node info
Used by actions: DescribeCloudNativeAPIGatewayNodes.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Retrieve the cloud native API gateway node list response result. |
| NodeList | Array of CloudNativeAPIGatewayNode | Cloud native API gateway node list. |
Retrieve the response result of the Cloud Native API gateway basic information.
Used by actions: DescribeCloudNativeAPIGateway, DescribeCloudNativeAPIGateways.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Cloud Native API Gateway ID. |
| Status | String | Cloud native API gateway status. |
| Name | String | Cloud native API gateway name. |
| Type | String | Cloud native API gateway type. |
| GatewayVersion | String | Instance version: - 2.4.1 - 2.5.1 |
| NodeConfig | CloudNativeAPIGatewayNodeConfig | Cloud native API gateway node information. |
| VpcConfig | CloudNativeAPIGatewayVpcConfig | Cloud native API gateway vpc configuration. |
| Description | String | Cloud native API gateway description. |
| CreateTime | String | Creation time of the cloud native API gateway. |
| Tags | Array of InstanceTagInfo | Tag information of the instance |
| EnableCls | Boolean | Is cls log enabled? |
| TradeType | Integer | Payment mode. 0 indicates postpaid, and 1 indicates prepaid. |
| FeatureVersion | String | Instance version. Currently supported: development edition, standard version, and professional version [TRIAL, STANDARD, PROFESSIONAL]. |
| InternetMaxBandwidthOut | Integer | Public network outbound traffic bandwidth, [1,2048]Mbps |
| AutoRenewFlag | Integer | Auto-renewal flag. 0 means the default state (not set by the user, that is, the initial state). 1 means auto-renew, 2 means no automatic renewal (set by the user). If the business has no renewal concept or no need for auto-renewal, set it to 0. |
| CurDeadline | String | Expiry time, used when prepaid |
| IsolateTime | String | Isolation time. Used when an instance is isolated. |
| EnableInternet | Boolean | Is client public network enabled? |
| EngineRegion | String | Actual regional information of the instance |
| IngressClassName | String | Ingress class name |
| InternetPayMode | String | Public network billing method. Selectable values: BANDWIDTH |
| GatewayMinorVersion | String | Cloud Native API Gateway minor version number |
| InstancePort | InstancePort | Ports monitored by the instance |
| LoadBalancerType | String | Public network CLB default type |
| PublicIpAddresses | Array of String | Public IP address list |
| DeleteProtect | Boolean | Whether to enable deletion protection |
| AvailableVersions | Array of String | Version number that can be upgraded Note: This field may return null, indicating that no valid values can be obtained. |
| AvailableUpgradeVersions | Array of String | Version list for gateway upgrade |
| AvailableUpgrade | Boolean | Whether to prompt for upgrade |
| AvailableRollbackVersion | String | Rollback version |
Retrieve the response result of the protocol port list for a cloud-native API gateway instance
Used by actions: DescribeCloudNativeAPIGatewayPorts.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Cloud Native API Gateway ID |
| GatewayInstancePortList | Array of GatewayInstanceSchemeAndPorts | Gateway instance protocol port list |
Query cloud native gateway instance info based on public network IP
Used by actions: DescribeCloudNativeAPIGatewayInfoByIp.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Instance ID. |
| GroupId | String | Group ID |
Query cross-origin configuration output parameters
Used by actions: DescribeCloudNativeAPIGatewayCORS.
| Name | Type | Description |
|---|---|---|
| SourceType | String | Resource type. |
| SourceId | String | Resource ID |
| Enabled | Boolean | enabled or not |
| Origins | Array of String | Cross-origin Origins |
| Headers | Array of String | Cross-Origin Headers |
| Methods | Array of String | Cross-origin Methods |
| ExposedHeaders | Array of String | Cross-Origin ExposedHeaders |
| MaxAge | Integer | Cache time of cross-origin OPTIONS request |
| Credentials | Boolean | Whether cross-origin access requests are allowed to carry identity information |
| PreFlightContinue | Boolean | Whether to forward cross-origin access requests to the backend |
Retrieve the cloud native api Gateway public IP address info response result
Used by actions: DescribePublicAddressConfig.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Gateway instance ID |
| ConfigList | Array of PublicAddressConfig | Public IP address info |
| TotalCount | Integer | Total number |
Query client public network information
Used by actions: DescribePublicNetwork.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Gateway instance ID |
| GroupId | String | gateway group ID |
| PublicNetwork | CloudNativeAPIGatewayConfig | Client public network information |
Retrieve WAF-protected domain name list
Used by actions: DescribeWafDomains.
| Name | Type | Description |
|---|---|---|
| Domains | Array of String | WAF-protected domain name list Note: This field may return null, indicating that no valid values can be obtained. |
Retrieve WAF protection resource status
Used by actions: DescribeWafProtection.
| Name | Type | Description |
|---|---|---|
| GlobalStatus | String | Global protection status |
| ServicesStatus | Array of ServiceWafStatus | Protection status |
| RouteStatus | Array of RouteWafStatus | Route protection status |
| ObjectStatus | String | Object protection status |
Cloud-native gateway traffic throttling plugin external redis configuration
Used by actions: CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit.
| Name | Type | Required | Description |
|---|---|---|---|
| RedisHost | String | Yes | redis ip |
| RedisPassword | String | Yes | redis password |
| RedisPort | Integer | Yes | redis port |
| RedisTimeout | Integer | Yes | Timeout interval. Unit: ms |
Query filter general object
Used by actions: DescribeCloudNativeAPIGateways, DescribeNativeGatewayServerGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Filter parameter name |
| Values | Array of String | Yes | Filter parameter value |
Protocol port list of the gateway instance
Used by actions: DescribeCloudNativeAPIGatewayPorts.
| Name | Type | Description |
|---|---|---|
| Scheme | String | Port protocol, selectable HTTP, HTTPS, TCP, and UDP. |
| PortList | Array of Integer | port list |
Lightweight querying the gateway service list output parameters
Used by actions: DescribeCloudNativeAPIGatewayServicesLight.
| Name | Type | Description |
|---|---|---|
| ServiceList | Array of KongServiceLightPreview | Service list |
| TotalCount | Integer | Total number of results |
Lane group
Used by actions: CreateGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | lane name Note: This field may return null, indicating that no valid values can be obtained. |
| ID | String | No | Lane group ID Note: This field may return null, indicating that no valid values can be obtained. |
| TrafficEntries | Array of LaneTrafficEntry | No | Lane entry service list Note: This field may return null, indicating that no valid values can be obtained. |
| Destinations | Array of GovernanceServiceDestination | No | Lane service list Note: This field may return null, indicating that no valid values can be obtained. |
| Description | String | No | Lane group description Note: This field may return null, indicating that no valid values can be obtained. |
| Rules | Array of GovernanceLaneRule | No | Lane rule list of ALL lane groups Note: This field may return null, indicating that no valid values can be obtained. |
| Revision | String | No | Rule content summary Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | No | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| ModifyTime | String | No | Modification time. Note: This field may return null, indicating that no valid values can be obtained. |
| Consistency | String | No | Rule consistency status Note: This field may return null, indicating that no valid values can be obtained. |
Lane rule
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| ID | String | No | Lane rule ID Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | No | lane name Note: This field may return null, indicating that no valid values can be obtained. |
| LaneGroup | String | No | Swimlane group of the lane Note: This field may return null, indicating that no valid values can be obtained. |
| Enable | Boolean | No | Rule Enable Status Note: This field may return null, indicating that no valid values can be obtained. |
| TrafficLabels | Array of Argument | No | Traffic Tag Note: This field may return null, indicating that no valid values can be obtained. |
| TrafficMatchMode | String | No | Multiple traffic tag matching methods AND OR Note: This field may return null, indicating that no valid values can be obtained. |
| LaneMatchMode | String | No | Lane match mode STRICT: Strict match PERMISSIVE: Loose match Note: This field may return null, indicating that no valid values can be obtained. |
| TrafficGray | TrafficGray | No | Lane grayscale rule |
| Description | String | No | Lane rule description Note: This field may return null, indicating that no valid values can be obtained. |
| LaneLabelValue | String | No | Lane tag content Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | No | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| EnableTime | String | No | Enabling time Note: This field may return null, indicating that no valid values can be obtained. |
| ModifyTime | String | No | Modification time. Note: This field may return null, indicating that no valid values can be obtained. |
| Priority | Integer | No | Lane rule priority Note: This field may return null, indicating that no valid values can be obtained. |
| Revision | String | No | Rule abstract Note: This field may return null, indicating that no valid values can be obtained. |
Service instance group
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Namespace | String | Yes | Namespace Note: This field may return null, indicating that no valid values can be obtained. |
| Service | String | Yes | Service. Note: This field may return null, indicating that no valid values can be obtained. |
| Labels | Array of RoutingDestinationRuleLabel | No | Instance tag Note: This field may return null, indicating that no valid values can be obtained. |
Instance listen port information
Used by actions: DescribeCloudNativeAPIGateway.
| Name | Type | Description |
|---|---|---|
| HttpPort | String | Listen http port range. |
| HttpsPort | String | Listen port range for https. |
| TcpPort | String | Listen port range for tcp. |
| UdpPort | String | Listen udp port range. |
Tag information of the engine instance
Used by actions: CreateCloudNativeAPIGateway, DescribeCloudNativeAPIGateway.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | No | Tag key. |
| TagValue | String | No | Tag value. |
Public network load balancing configuration
Used by actions: CreateCloudNativeAPIGateway, CreateCloudNativeAPIGatewayPublicNetwork, CreateNativeGatewayServerGroup.
| Name | Type | Required | Description |
|---|---|---|---|
| InternetAddressVersion | String | No | Public network address version. Optional: "IPV4" |
| InternetPayMode | String | No | Public network payment mode. Currently, only "BANDWIDTH" is selectable. Defaults to "BANDWIDTH" if left blank. |
| InternetMaxBandwidthOut | Integer | No | Public network bandwidth. |
| Description | String | No | Description of load balancing |
| SlaType | String | No | Load balancing specification type. Support clb.c2.medium, clb.c3.small, clb.c3.medium, clb.c4.small, clb.c4.medium, clb.c4.large, clb.c4.xlarge. Defaults to shared type. |
| MultiZoneFlag | Boolean | No | Whether load balancing is multi-availability zone |
| MasterZoneId | String | No | Primary AZ. |
| SlaveZoneId | String | No | standby availability zone |
Key-value pair
Used by actions: CreateCloudNativeAPIGatewayRoute, CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayRoutes, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRoute, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | key |
| Value | String | No | value |
Key/Value structure
Used by actions: CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Key of the condition |
| Value | String | No | Value of the condition |
Kong gateway proactive health check configuration
Used by actions: DescribeUpstreamHealthCheckConfig, UpdateUpstreamHealthCheckConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| HealthyInterval | Integer | No | Probe interval for active health check in seconds. 0 means disabled. |
| UnHealthyInterval | Integer | No | Proactive health check exception probe interval, unit: second. 0 indicates disabled. |
| HttpPath | String | No | Path used in GET HTTP request to run as a proactive health check probe. Default: "/". |
| Timeout | Float | No | Timeout for GET HTTP requests, unit: seconds. Default 60. |
Cloud-native gateway certificate
Used by actions: DescribeCloudNativeAPIGatewayCertificateDetails.
| Name | Type | Description |
|---|---|---|
| Cert | KongCertificatesPreview | None. |
Certificate list of the kong instance
Used by actions: DescribeCloudNativeAPIGatewayCertificates.
| Name | Type | Description |
|---|---|---|
| Total | Integer | Total Quantity of Certificate Lists |
| CertificatesList | Array of KongCertificatesPreview | None. Note: This field may return null, indicating that no valid values can be obtained. |
Cloud-native gateway certificate preview information
Used by actions: DescribeCloudNativeAPIGatewayCertificateDetails, DescribeCloudNativeAPIGatewayCertificates.
| Name | Type | Description |
|---|---|---|
| Name | String | certificate name |
| Id | String | Id |
| BindDomains | Array of String | Bound domain name |
| Status | String | Certificate status: expired. active |
| Crt | String | Certificate in pem format |
| Key | String | Certificate Private Key |
| ExpireTime | String | certificate expiration time |
| CreateTime | String | Certificate upload time |
| IssueTime | String | Certificate issuance time |
| CertSource | String | Certificate source: native (kong custom certificate) ssl (platform cert) |
| CertId | String | ssl Platform Certificate Id |
Kong gateway passive health check configuration
Used by actions: DescribeUpstreamHealthCheckConfig, UpdateUpstreamHealthCheckConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | Backend target protocol type. Passive health check supports http and tcp. Proactive health check supports http. |
Cloud-native gateway routing information
Used by actions: DescribeCloudNativeAPIGatewayRoutes.
| Name | Type | Required | Description |
|---|---|---|---|
| ID | String | Yes | Service ID |
| Name | String | No | Service name. |
| Methods | Array of String | No | None. Note: This field may return null, indicating that no valid values can be obtained. |
| Paths | Array of String | No | None. Note: This field may return null, indicating that no valid values can be obtained. |
| Hosts | Array of String | No | None. Note: This field may return null, indicating that no valid values can be obtained. |
| Protocols | Array of String | No | None. |
| PreserveHost | Boolean | No | None. |
| HttpsRedirectStatusCode | Integer | No | None. |
| StripPath | Boolean | No | None. |
| CreatedTime | String | No | None. |
| ServiceName | String | No | Service name |
| ServiceID | String | No | Service ID |
| DestinationPorts | Array of Integer | No | Destination Port |
| Headers | Array of KVMapping | No | Headers of the route |
| RequestBuffering | Boolean | No | Whether to cache the request body, default true |
| ResponseBuffering | Boolean | No | Whether to cache response body, default true |
| RegexPriority | Integer | No | Regular Priority |
| QueryStringParameters | Array of KVMapping | No | querystring parameter |
Service details of cloud-native gateway
Used by actions: DescribeOneCloudNativeAPIGatewayService.
| Name | Type | Required | Description |
|---|---|---|---|
| ID | String | Yes | service ID |
| Name | String | No | Service name. |
| Protocol | String | No | Backend protocol |
| Path | String | No | Backend path Note: This field may return null, indicating that no valid values can be obtained. |
| Timeout | Integer | No | Backend delay in milliseconds |
| Retries | Integer | No | Number of retries. |
| Tags | Array of String | No | Tag. Note: This field may return null, indicating that no valid values can be obtained. |
| UpstreamInfo | KongUpstreamInfo | No | backend configuration |
| UpstreamType | String | No | Backend type |
| Editable | Boolean | No | Whether it is editable. |
| CreatedTime | String | No | Creation time. |
Simple Preview Information of Cloud-Native Gateway Service
Used by actions: DescribeCloudNativeAPIGatewayServicesLight.
| Name | Type | Description |
|---|---|---|
| ID | String | service ID |
| Name | String | Service name. |
| UpstreamInfo | KongUpstreamInfo | backend configuration |
| UpstreamType | String | Backend type |
| CreatedTime | String | Creation time. |
| Path | String | request path Note: This field may return null, indicating that no valid values can be obtained. |
| Protocol | String | Backend protocol |
| Retries | Integer | Number of retries. |
| Timeout | Integer | Backend delay in milliseconds |
Preview Information of Cloud-Native Gateway Service
Used by actions: DescribeCloudNativeAPIGatewayServices.
| Name | Type | Required | Description |
|---|---|---|---|
| ID | String | Yes | service ID |
| Name | String | No | Service name. |
| Tags | Array of String | No | Tag. |
| UpstreamInfo | KongUpstreamInfo | No | backend configuration |
| UpstreamType | String | No | Backend type |
| CreatedTime | String | No | Creation time. |
| Editable | Boolean | No | Whether it is editable. |
| Path | String | No | request path Note: This field may return null, indicating that no valid values can be obtained. |
Service route list of kong
Used by actions: DescribeCloudNativeAPIGatewayRoutes.
| Name | Type | Required | Description |
|---|---|---|---|
| RouteList | Array of KongRoutePreview | No | None. |
| TotalCount | Integer | No | Total number. |
Service list of the kong instance
Used by actions: DescribeCloudNativeAPIGatewayServices.
| Name | Type | Required | Description |
|---|---|---|---|
| ServiceList | Array of KongServicePreview | No | Service list of the kong instance |
| TotalCount | Integer | No | Total Quantity of Lists |
Target in Kong Upstream
Used by actions: CreateCloudNativeAPIGatewayService, DescribeCloudNativeAPIGatewayUpstream, ModifyCloudNativeAPIGatewayService, UpdateUpstreamTargets.
| Name | Type | Required | Description |
|---|---|---|---|
| Host | String | Yes | Host |
| Port | Integer | Yes | Port. |
| Weight | Integer | Yes | Weight |
| Health | String | No | Health status. |
| CreatedTime | String | No | Creation time. |
| Source | String | No | Source of the Target |
| CvmInstanceId | String | No | CVM instance ID |
| CvmInstanceName | String | No | CVM instance name. |
| Tags | Array of String | No | target tag |
backend configuration of the service
Used by actions: CreateCloudNativeAPIGatewayService, DescribeCloudNativeAPIGatewayServices, DescribeCloudNativeAPIGatewayServicesLight, DescribeOneCloudNativeAPIGatewayService, ModifyCloudNativeAPIGatewayService.
| Name | Type | Required | Description |
|---|---|---|---|
| Host | String | No | IP or domain |
| Port | Integer | No | Port. |
| SourceID | String | No | Service source ID |
| Namespace | String | No | Namespace |
| ServiceName | String | No | Service (registration center or service in Kubernetes) name |
| Targets | Array of KongTarget | No | The backend type is IPList when provided by the service Note: This field may return null, indicating that no valid values can be obtained. |
| SourceType | String | No | Service source type |
| ScfType | String | No | SCF Function Type |
| ScfNamespace | String | No | SCF function namespace |
| ScfLambdaName | String | No | SCF Function Name |
| ScfLambdaQualifier | String | No | SCF Function Version |
| SlowStart | Integer | No | Cold start time, in seconds |
| Algorithm | String | No | Load balancing algorithm, defaults to round-robin, also supports least-connections, consisten_hashing |
| AutoScalingGroupID | String | No | Auto scaling group ID of CVM |
| AutoScalingCvmPort | Integer | No | CVM auto scaling group port |
| AutoScalingTatCmdStatus | String | No | TAT command status of the CVM used in the auto scaling group |
| AutoScalingHookStatus | String | No | CVM auto scaling group lifecycle hook status |
| SourceName | String | No | Service source name. |
| RealSourceType | String | No | Precise service source type. Type passed in when creating a service source. |
| HealthStatus | String | No | upstream health status HEALTHY (healthy), UNHEALTHY (abnormal), HEALTHCHECKS_OFF (not enabled), and NONE (health checks not supported) |
| ScfCamAuthEnable | Boolean | No | Whether CAM authentication is enabled for SCF. Enabled by default (true) when left blank. |
| ScfIsBase64Encoded | Boolean | No | Whether Base64 encoding is enabled for SCF, default false |
| ScfIsIntegratedResponse | Boolean | No | Whether response integration is enabled for the cloud function, default false |
kong backend upstream list
Used by actions: DescribeCloudNativeAPIGatewayUpstream.
| Name | Type | Required | Description |
|---|---|---|---|
| UpstreamList | Array of KongUpstreamPreview | No | None. |
Cloud-native gateway Upstream info
Used by actions: DescribeCloudNativeAPIGatewayUpstream.
| Name | Type | Required | Description |
|---|---|---|---|
| ID | String | Yes | Service ID |
| Name | String | No | Service name. |
| Target | Array of KongTarget | No | Backend configuration |
Tag.
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Tag key name |
| Value | String | No | Tag value. |
lane entrance info
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| EntryType | String | No | // If type == "polarismesh.cn/gateway/tse-gateway", the selector is TSEGatewaySelector. // type == "polarismesh.cn/gateway/spring-cloud-gateway", selector is ServiceGatewaySelector // If type == "polarismesh.cn/service", selector is ServiceSelector Note: This field may return null, indicating that no valid values can be obtained. |
| TSEGatewaySelector | TSEGatewaySelector | No | TSE cloud-native gateway selector Note: This field may return null, indicating that no valid values can be obtained. |
| ServiceGatewaySelector | ServiceGatewaySelector | No | Microservice gateway selector Note: This field may return null, indicating that no valid values can be obtained. |
| ServiceSelector | ServiceSelector | No | Standard microservice selector Note: This field may return null, indicating that no valid values can be obtained. |
Parameter throttling rule
Used by actions: CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit.
| Name | Type | Required | Description |
|---|---|---|---|
| Filters | Array of RuleFilter | No | Request matching conditions |
| LimitBy | Array of KeyValue | No | Parameter throttling based on composite |
| QpsThresholds | Array of QpsThreshold | No | Throttling threshold |
| AccurateQpsThresholds | Array of AccurateQpsThreshold | No | Precise throttling threshold |
Retrieve the response result of the Cloud Native API gateway instance list.
Used by actions: DescribeCloudNativeAPIGateways.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total quantity. |
| GatewayList | Array of DescribeCloudNativeAPIGatewayResult | Cloud Native API gateway instance list. |
Retrieve the response result of the gateway grouping list bound to the instance policy for a cloud-native API gateway.
Used by actions: DescribeAutoScalerResourceStrategyBindingGroups.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Quantity. |
| GroupInfos | Array of CloudNativeAPIGatewayStrategyBindingGroupInfo | Cloud native API gateway instance policy binding gateway grouping list |
Retrieve the response result of the Cloud Native API gateway instance policy.
Used by actions: DescribeAutoScalerResourceStrategies.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total quantity. |
| StrategyList | Array of CloudNativeAPIGatewayStrategy | Cloud Native API gateway instance policy list. |
Filter conditions, fuzzy matching
Used by actions: DescribeCloudNativeAPIGatewayCertificates, DescribeCloudNativeAPIGatewayRoutes, DescribeCloudNativeAPIGatewayServices, DescribeCloudNativeAPIGatewayServicesLight.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Filter fields |
| Value | String | No | Values after filtering |
Cloud-Native Gateway Group Information
Used by actions: DescribeNativeGatewayServerGroups.
| Name | Type | Description |
|---|---|---|
| GroupId | String | Cloud-Native Gateway Group Unique id |
| Name | String | Group name |
| Description | String | Description information |
| NodeConfig | CloudNativeAPIGatewayNodeConfig | Node specification, number of nodes info |
| Status | String | Gateway group status. |
| CreateTime | String | Creation time. |
| IsFirstGroup | Integer | Whether it is the default group. 0: No. 1: Yes. |
| BindingStrategy | CloudNativeAPIGatewayStrategy | Associate policy information |
| GatewayId | String | Gateway instance ID. |
| InternetMaxBandwidthOut | Integer | Bandwidth |
| ModifyTime | String | Modification time. |
| SubnetIds | String | Subnet ID |
| DefaultWeight | Integer | Default weight of the group |
| ElasticNumber | Integer | elastic node |
| SupportTOA | Boolean | Whether TOA is supported |
| SupportIPV6 | Boolean | Whether IPV6 is supported |
gateway group list
Used by actions: DescribeNativeGatewayServerGroups.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number. |
| GatewayGroupList | Array of NativeGatewayServerGroup | Group information array. |
Gateway data source description
Used by actions: DescribeNativeGatewayServiceSources.
| Name | Type | Description |
|---|---|---|
| GatewayID | String | Gateway instance ID |
| SourceID | String | Service Source ID |
| SourceName | String | Service Source Name |
| SourceType | String | Service source type |
| SourceInfo | SourceInfo | Service source additional information |
| CreateTime | String | Creation time. |
| ModifyTime | String | Modification time. |
Network access policy
Used by actions: DescribeCloudNativeAPIGatewayConfig, DescribePublicNetwork, ModifyConsoleNetwork, ModifyNetworkAccessStrategy.
| Name | Type | Required | Description |
|---|---|---|---|
| Mode | String | Yes | Access mode: Whitelist |
| CidrWhiteList | Array of String | No | List of allowlist |
| CidrBlackList | Array of String | No | blocklist |
Public IP address info
Used by actions: DescribePublicAddressConfig.
| Name | Type | Description |
|---|---|---|
| Vip | String | Public ip address |
| InternetMaxBandwidthOut | Integer | Maximum public network bandwidth |
| GroupId | String | public network associated group id |
| GroupName | String | Public network associated group name |
| NetworkId | String | Public network CLB id |
| Description | String | Description of public network CLB |
Cloud-native gateway traffic throttling plugin Qps threshold
Used by actions: CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit.
| Name | Type | Required | Description |
|---|---|---|---|
| Unit | String | Yes | qps threshold control dimension, including: second, minute, hour, day, month, year. |
| Max | Integer | Yes | Threshold. |
Cloud-Native Gateway Traffic Throttling Plugin Custom Response
Used by actions: CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit.
| Name | Type | Required | Description |
|---|---|---|---|
| Body | String | No | Custom response body |
| Headers | Array of KVMapping | No | Headers |
| HttpStatus | Integer | No | HTTP status code. |
Route WAF status
Used by actions: DescribeWafProtection.
| Name | Type | Description |
|---|---|---|
| Name | String | Route name |
| Id | String | ID of the route |
| Status | String | Whether WAF protection is enabled for the route |
| Methods | Array of String | Method. |
| Paths | Array of String | Path. |
| Hosts | Array of String | Domain |
| ServiceName | String | Name of the service corresponding to the route |
| ServiceId | String | ID of the service corresponding to the route |
Target service instance instance tag info
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| LabelKey | String | No | Tag key. Note: This field may return null, indicating that no valid values can be obtained. |
| LabelValue | String | No | Tag value. Note: This field may return null, indicating that no valid values can be obtained. |
| LabelType | String | No | expression type Note: This field may return null, indicating that no valid values can be obtained. |
| LabelValueType | String | No | value type Note: This field may return null, indicating that no valid values can be obtained. |
Throttling rule Filter
Used by actions: CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Key of throttling conditions |
| Values | Array of String | No | Values of throttling conditions |
| Operator | String | No | operator |
| Name | String | No | name in header or query |
microservice gateway selector
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Namespace | String | Yes | Namespace Note: This field may return null, indicating that no valid values can be obtained. |
| Service | String | Yes | Service. Note: This field may return null, indicating that no valid values can be obtained. |
| Labels | Array of Label | No | Instance tag Note: This field may return null, indicating that no valid values can be obtained. |
ordinary service selector
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Namespace | String | Yes | Namespace Note: This field may return null, indicating that no valid values can be obtained. |
| Service | String | Yes | Service. Note: This field may return null, indicating that no valid values can be obtained. |
| Labels | Array of Label | No | Instance tag Note: This field may return null, indicating that no valid values can be obtained. |
WAF status of the service
Used by actions: DescribeWafProtection.
| Name | Type | Description |
|---|---|---|
| Name | String | Service name |
| Id | String | Service ID |
| Type | String | Service type |
| Status | String | Whether WAF protection is enabled for the service |
service source
Used by actions: CreateNativeGatewayServiceSource, DescribeNativeGatewayServiceSources, ModifyNativeGatewayServiceSource.
| Name | Type | Required | Description |
|---|---|---|---|
| Addresses | Array of String | No | Microservice engine integration IP address information |
| VpcInfo | SourceInstanceVpcInfo | No | VPC information of the microservice engine |
| Auth | SourceInstanceAuth | No | Microservice engine authentication information |
Instance authentication information
Used by actions: CreateNativeGatewayServiceSource, ModifyNativeGatewayServiceSource.
| Name | Type | Required | Description |
|---|---|---|---|
| Username | String | No | Username. |
| Password | String | No | account password |
| AccessToken | String | No | token credential |
VPC information of the microservice engine instance
Used by actions: CreateNativeGatewayServiceSource, ModifyNativeGatewayServiceSource.
| Name | Type | Required | Description |
|---|---|---|---|
| VpcID | String | No | VPC information of the microservice engine |
| SubnetID | String | No | Microservice engine subnet info |
Gateway service information match condition
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| GatewayId | String | Yes | Gateway engine instance ID Note: This field may return null, indicating that no valid values can be obtained. |
| Services | Array of String | No | Gateway service Note: This field may return null, indicating that no valid values can be obtained. |
Traffic grayscale rule for lanes
Used by actions: CreateGovernanceLaneGroups, DeleteGovernanceLaneGroups, DescribeGovernanceLaneGroups, ModifyGovernanceLaneGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| Mode | String | No | Grayscale release rules for traffic, grayscale by ratio or preheat method |
| Percent | Integer | No | Grayscale percentage value 1-100 by proportion |
| IntervalSecond | Integer | No | Preheated interval |
| Curvature | Integer | No | Preheated curvature |
Refresh the cloud native API gateway response result.
Used by actions: UpdateCloudNativeAPIGatewaySpec.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Cloud Native API Gateway ID. |
| Status | String | Cloud-native gateway status. |
| TaskId | String | Task ID. |
Cloud-native gateway health check configuration
Used by actions: DescribeUpstreamHealthCheckConfig, UpdateUpstreamHealthCheckConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| EnableActiveHealthCheck | Boolean | No | Enable active health check |
| ActiveHealthCheck | KongActiveHealthCheck | No | Active health check configuration |
| EnablePassiveHealthCheck | Boolean | No | Enable passive health check |
| PassiveHealthCheck | KongPassiveHealthCheck | No | Passive health check configuration |
| Successes | Integer | No | Consecutive health threshold, unit: times |
| Failures | Integer | No | Continuous anomaly threshold, unit: times |
| Timeouts | Integer | No | Timeout threshold, unit: times |
| HealthyHttpStatuses | Array of Integer | No | Healthy HTTP status code |
| UnhealthyHttpStatuses | Array of Integer | No | abnormal HTTP status code |
| ZeroWeightHeathCheck | Boolean | No | Health check supports nodes with support weights of 0 |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan