All Products
Search
Document Center

API Gateway:PolicyInfo

Last Updated:Dec 17, 2025
ParameterTypeDescriptionExample
object

The information about the policy.

policyIdstring

The policy ID.

p-cq7l5s5lhtgi6qasrdc0
directionstring

The direction of traffic on which the policy takes effect. Valid values:

  • OutBound
  • InBound
  • Both
InBound
classNamestring

The class name supported by the policy. Different policies support different mount points. This parameter is used in combination with AttachResourceType.

  • RateLimit: throttles traffic. Supported: HttpApi, Operation, and GatewayRoute.
  • ConcurrencyLimit: controls concurrency. Supported: HttpApi, Operation, and GatewayRoute.
  • CircuitBreaker: breaks circuits and downgrades traffic. Supported: HttpApi, Operation, and GatewayRoute.
  • HttpRewrite: rewrites HTTP traffic. Supported: HttpApi, Operation, and GatewayRoute.
  • HeaderModify: modifies headers. Supported: HttpApi, Operation, and GatewayRoute.
  • Cors: supports CORS. Supported: HttpApi, Operation, and GatewayRoute.
  • FlowCopy: replicates traffic. Supported: HttpApi, Operation, and GatewayRoute.
  • Timeout: times out requests. Supported: HttpApi, Operation, and GatewayRoute.
  • Retry: retries requests. Supported: HttpApi, Operation, and GatewayRoute.
  • IpAccessControl: implements IP address-based access control. Supported: HttpApi, Operation, GatewayRoute, Domain, and Gateway.
  • DirectResponse: mocks responses. Supported: Operation and GatewayRoute.
  • Redirect: redirects traffic. Supported: GatewayRoute.
  • Fallback: implements fallback. Supported: Operation and GatewayRoute.
  • ServiceTls: implements TLS authentication. Supported: GatewayService.
  • ServiceLb: balances loads. Supported: GatewayService.
  • ServicePortTls: implements service port TLS authentication. Supported: GatewayServicePort.
  • Waf: implements WAF protection. Supported: GatewayRoute and Gateway.
  • JWTAuth: implements global JWT authentication. Supported: Gateway.
  • OIDCAuth: implements global OIDC authentication. Supported: Gateway.
  • ExternalZAuth: implements custom authentication. Supported: Gateway.
classAliasstring

The policy class alias.

configstring

The policy configurations.

{"enable":false}
attachmentsarray

The mount information.

Attachment

The mount information.

namestring

The policy name.

test-policy
typestring

The policy type.

executeStagestring

The execution phase.

Valid values:

  • PluginStatistic
  • PluginAuthorization
  • PluginPre
  • PluginAuthentication
  • PluginDefault
  • PluginPost
PluginPost
executePrioritystring

The execution priority.

310