CreateAndAttachPolicy - 创建并附加策略-API 网关(API Gateway)-阿里云帮助中心

创建并附加策略。

调试

您可以在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.	{'key': 'value'}
name	string	否	策略名称。 className 为 IpAccessControl、JWTAuth、OIDCAuth、ExternalZAuth 时必填，且在当前账号的同一网关实例（gatewayId）下必须唯一。与已有策略重名时返回策略已存在错误（PolicyExisted）；收到该错误后重试时必须更换新的 name，重复提交相同 name 将始终失败。其余 className（如 RateLimit、Timeout、Retry、ServiceTls、AiProxy 等）name 为可选，仅用于展示，可省略。	my-fallback-policy
className	string	是	策略类型	AiFallback
config	string	是	策略配置内容（JSON 字符串）	{"serviceConfigs":[...]}
description	string	否	策略描述	主路由失败时回退
attachResourceIds	array	是	挂载目标资源 ID 列表
	string	否	挂载目标资源 ID 列表	["route-xxx"]
attachResourceType	string	是	挂载目标资源类型	GatewayRoute
environmentId	string	否	环境 ID	env-test
gatewayId	string	否	网关 ID	gw-xxx

返回参数

名称	类型	描述	示例值
	object	object
requestId	string	Request ID	585657D2-1C20-5B8A-AF17-D727C6490BE4
code	string	响应状态码	200
message	string	响应信息	success
data	object	响应结构
policyId	string	新创建的策略 ID	plc-xxx
attachment	Attachment	挂载关系信息

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。