DocsICP FilingConsole
Documentation

CreatePolicy

Updated at:
Copy as MD
Product
My Favorites

Creates a policy.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apig:CreatePolicy

none

*All Resource

*

 None None

Request syntax

POST /v2/policies HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request body.

{'key': 'value'}
className

string

Yes

The policy type. Valid values: RateLimit, ConcurrencyLimit, CircuitBreaker, HttpRewrite, HeaderModify, Cors, Authentication, FlowCopy, Timeout, Retry, IpAccessControl, DirectResponse, Redirect, Fallback, ServiceTls, ServiceLb, ServicePortTls, Waf, JWTAuth, OIDCAuth, ExternalZAuth, AiProxy, ModelRouter, AiStatistics, AiSecurityGuard, AiFallback, ModelMapper, AiTokenRateLimit, AiCache, and DynamicRoute.

Valid values:

  • ServicePortTls :

    Service port TLS. The TLS configuration for backend service ports.

  • CircuitBreaker :

    Circuit breaker. Automatically triggers circuit breaking when backend errors occur.

  • IpAccessControl :

    IP access control. Filters requests based on IP address allowlists and blocklists.

  • HeaderModify :

    Header modification. Adds, deletes, or modifies HTTP request headers.

  • ExternalZAuth :

    External authentication. Integrates with external authentication services.

  • RateLimit :

    Rate limiting. Limits the request rate.

  • AiTokenRateLimit :

    AI token rate limiting. Limits requests based on token consumption.

  • DirectResponse :

    Direct response. Directly returns a fixed response.

  • OIDCAuth :

    OIDC authentication. Authenticates requests based on the OIDC protocol.

  • AiSecurityGuard :

    AI security protection. Detects security risks in AI request and response content.

  • ConcurrencyLimit :

    Concurrency limiting. Limits the number of concurrent requests.

  • ServiceTls :

    Service TLS. The TLS configuration for backend services.

  • AiCache :

    AI caching. Caches AI response results.

  • Timeout :

    Timeout policy. Sets the request timeout period.

  • FlowCopy :

    Traffic mirroring. Copies requests to an additional backend.

  • Redirect :

    Redirection. Redirects requests to another address.

  • Cors :

    Cross-Origin Resource Sharing (CORS). Controls cross-origin requests.

  • JWTAuth :

    JWT authentication. Authenticates requests based on JWT.

  • ServiceLb :

    Service load balancing. The load balancing configuration for backend services.

  • Authentication :

    General authentication. A general request authentication policy.

  • Fallback :

    Fallback policy. Returns a fallback response when the backend is unavailable.

  • Retry :

    Retry policy. Automatically retries failed requests.

  • AiFallback :

    AI fallback. Falls back to an alternative model when the AI service is unavailable.

  • Waf :

    Web Application Firewall (WAF). Provides request security protection.

  • HttpRewrite :

    HTTP rewrite. Rewrites the request URL or path.

Timeout
config

string

Yes

The policy configuration.

{"unitNum":1,"timeUnit":"s","enable":true}
description

string

No

The description.

Timeout policy
name

string

Yes

The policy name.

test-policy

Response elements

Element

Type

Description

Example

object

Schema of Response

code

string

The response status code.

Ok
data

object

The response data.

policyId

string

The policy ID.

p-cq7l5s5lhtgi6qasr***

message

string

The response message.

success
requestId

string

The request ID.

393E2630-DBE7-5221-AB35-9E7406754***

Examples

Success response

JSON format

{
  "code": "Ok",
  "data": {
    "policyId": "p-cq7l5s5lhtgi6qasr***\n"
  },
  "message": "success",
  "requestId": "393E2630-DBE7-5221-AB35-9E7406754***"
}

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidParameter.IsEmpty Parameter className should not be empty.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.