CreateAndAttachPolicy - Create and Attach Policy_API 网关(API Gateway)-阿里云帮助中心

CreateAndAttachPolicy。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apig:CreateAndAttachPolicy	none	Policy `acs:apig:{#regionId}:{#accountId}:policy/`	无	无

请求语法

POST /v1/policies HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	Request Body.
name	string	否	Policy name.	test
className	string	是	The class name types supported by the policy. Different policies support different attachment points, to be used in conjunction with `attachResourceType`. RateLimit: Traffic control, supports HttpApi, Operation, GatewayRoute. ConcurrencyLimit: Concurrency control, supports HttpApi, Operation, GatewayRoute. CircuitBreaker: Circuit breaking and degradation, supports HttpApi, Operation, GatewayRoute. HttpRewrite: HTTP rewrite, supports HttpApi, Operation, GatewayRoute. HeaderModify: Header modification, supports HttpApi, Operation, GatewayRoute. Cors: Cross-origin, supports HttpApi, Operation, GatewayRoute. FlowCopy: Traffic replication, supports HttpApi, Operation, GatewayRoute. Timeout: Timeout, supports HttpApi, Operation, GatewayRoute. Retry: Retry, supports HttpApi, Operation, GatewayRoute. IpAccessControl: IP access control, supports HttpApi, Operation, GatewayRoute, Domain, Gateway. DirectResponse: Mock, supports Operation, GatewayRoute. Redirect: Redirection, supports GatewayRoute. Fallback: Fallback, supports Operation, GatewayRoute. ServiceTls: Service TLS authentication, supports GatewayService. ServiceLb: Service load balancing, supports GatewayService. ServicePortTls: Service port TLS authentication, supports GatewayServicePort. Waf: WAF protection, supports GatewayRoute, Gateway. JWTAuth: JWT global authentication, supports Gateway. OIDCAuth: OIDC global authentication, supports Gateway. ExternalZAuth: Custom authorization, supports Gateway.	IpAccessControl
config	string	是	Configuration information.	{\"enable\":false}
description	string	否	Policy description.	这是策略描述
attachResourceIds	array	是	List of attachment point IDs.
	string	否	Attachment point ID.	api-cq7l5s5lhtgi6qasrdc0
attachResourceType	string	是	Types of attachment points supported by the policy. HttpApi: HttpApi. Operation: Operation of HttpApi. GatewayRoute: Gateway route. GatewayService: Gateway service. GatewayServicePort: Gateway service port. Domain: Gateway domain. Gateway: Gateway.	HttpApi
environmentId	string	否	Environment ID.	env-cq7l5s5lhtgi6qasrdc0
gatewayId	string	否	Gateway ID.	gw-cq7l5s5lhtgi6qasrdc0

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Request ID, used for tracing the API call chain.	585657D2-1C20-5B8A-AF17-D727C6490BE4
code	string	Response code.	Ok
message	string	Response message.	success
data	object	Response data.
policyId	string	Policy ID.	p-cq7l5s5lhtgi6qasrdc0
attachment	Attachment	Attachment information.

示例

正常返回示例

JSON格式

{
  "requestId": "585657D2-1C20-5B8A-AF17-D727C6490BE4",
  "code": "Ok",
  "message": "success",
  "data": {
    "policyId": "p-cq7l5s5lhtgi6qasrdc0\n",
    "attachment": {
      "policyAttachmentId": "pr-cq7l5s5lhtgi6qasrdc0",
      "attachResourceIds": [
        "api-cq7l5s5lhtgi6qasrdc0"
      ],
      "attachResourceType": "HttpApi",
      "environmentId": "env-cq7l5s5lhtgi6qasrdc0",
      "gatewayId": "gw-cpr4f9dlhtgq5ksfgmb0"
    }
  }
}

错误码

访问错误中心查看更多错误码。