一、1. 接口描述
创建或编辑云原生网关访问控制
默认接口请求频率限制:20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:CreateOrModifyCloudNativeAPIGatewayIPRestriction。 |
| Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| AddressList.N | 是 | Array of String | cidr|ip示例值:["[1.1.1.1,2.2.2.2]"] |
| Enabled | 是 | Boolean | 是否启用插件示例值:true |
| GatewayId | 是 | String | 网关ID示例值:gateway-962b7d7c |
| RestrictionType | 是 | String | 访问控制类型:whiteList|blackList示例值:whiteList |
| SourceId | 是 | String | 路由或服务的id示例值:31f3bf99-f289-4b6e-8edc-5e09d9d8ce4e |
| SourceType | 是 | String | 访问控制插件绑定的资源类型:route|service示例值:route |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、示例1 创建或编辑云原生网关访问控制
创建或编辑云原生网关访问控制
五、输入示例
POST / HTTP/1.1
Host: cngw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudNativeAPIGatewayServiceRateLimit
<公共请求参数>
{
"GatewayId": "gateway-2f2e3c40",
"SourceType": "route",
"SourceId": "31f3bf99-f289-4b6e-8edc-5e09d9d8ce4e",
"Enabled": "true",
"RestrictionType": "whiteList",
"AddressList": [
"1.1.1.1"
]
}
六、输出示例
{
"Response": {
"RequestId": "741e4e82-371d-48de-a843-867c69ff114d"
}
}
七、腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便你从同一入口查询及使用腾讯云提供的所有 API 服务。
八、API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
九、SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
十、命令行工具
·Tencent Cloud CLI 3.0
十一、6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| FailedOperation | 操作失败。 |
| FailedOperation.FailedOperation | FailedOperation.FailedOperation |
| FailedOperation.InternalError | FailedOperation.InternalError |
| FailedOperation.Role | FailedOperation.Role |
| FailedOperation.Vpc | FailedOperation.Vpc |
| InternalError | 内部错误。 |
| InternalError.QueryError | InternalError.QueryError |
| InvalidParameterValue.BadRequestFormat | InvalidParameterValue.BadRequestFormat |
| InvalidParameterValue.InvalidParameterValue | InvalidParameterValue.InvalidParameterValue |
| InvalidParameterValue.OperationFailed | InvalidParameterValue.OperationFailed |
| InvalidParameterValue.Region | InvalidParameterValue.Region |
| InvalidParameterValue.ResourceAlreadyExist | InvalidParameterValue.ResourceAlreadyExist |
| InvalidParameterValue.Specification | InvalidParameterValue.Specification |
| InvalidParameterValue.Type | InvalidParameterValue.Type |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.MissParameter | MissingParameter.MissParameter |
| ResourceNotFound.InstanceNotFound | ResourceNotFound.InstanceNotFound |
| ResourceNotFound.ResourceNotFound | ResourceNotFound.ResourceNotFound |
| UnauthorizedOperation.CamNoAuth | UnauthorizedOperation.CamNoAuth |
| UnauthorizedOperation.CamPassRoleNotExist | UnauthorizedOperation.CamPassRoleNotExist |
| UnauthorizedOperation.Uin | UnauthorizedOperation.Uin |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |