调用AttachPolicy为API设置策略。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /v1/api/{apiId}/attach
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
apiId | Long | Path | 否 | 70 |
API唯一ID。 |
Array of data | Body | 否 |
请求Body。 |
||
creationDateTime | String | Body | 否 | 2020-09-24 10:51:45 |
策略创建时间。 |
direction | String | Body | 否 | INBOUND |
策略的作用方向。取值如下:
|
policyAliasName | String | Body | 否 | route |
策略别名。 |
policyContent | String | Body | 否 | zuul:\n |
策略内容。 |
policyGroup | String | Body | 否 | zuul |
策略组。 |
policyId | Long | Body | 否 | 1 |
策略ID。 |
policyName | String | Body | 否 | route |
策略名称。仅限字母、数字和下划线(_),最长255个字符,必须以字母开头。 |
priority | Long | Body | 否 | 0 |
策略优先级,可设置为0和正整数,数值越大优先级越高。 |
scope | String | Body | 否 | REQUEST |
策略作用范围。取值如下:
|
status | Boolean | Body | 否 | true |
策略状态。取值如下:
|
type | Long | Body | 否 | 0 |
策略类型。由策略组类型、策略code和网关类型三个参数确定策略类型。 例:ZUUL(PolicyGroupEnum.ROUTE, "ZUUL", 0, GatewayType.ZUUL) |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Long | 200 |
状态码。 |
data | Map |
返回数据。 |
|
message | String | success |
错误信息。 |
示例
请求示例
POST /v1/api/70/attach HTTP/1.1
{
"data":[
{
"data":{
"policyId":"1",
"policyName":"route",
"scope":"REQUEST",
"policyAliasName":"route",
"policyGroup":"zuul",
"priority":"0",
"type":"0",
"policyContent":"zuul:\\n",
"creationDateTime":"2020-09-24 10:51:45",
"direction":"INBOUND",
"status":"true"
}
}
]
}
正常返回示例
XML
格式
<AttachPolicyResponse>
<code>200</code>
<message>success</message>
</AttachPolicyResponse>
JSON
格式
{
"code": "200",
"message": "success"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | param_error | The param is must be in ... | |
403 | ACCESS_FORBIDEN | The param is must be in ... |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交