CreateAndAttachPolicy - 建立並附加策略 - 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.
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"
    }
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。