微服务引擎 TSE 修改云原生API网关实例网络基本信息-云原生网关相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： tse.tencentcloudapi.com 。

修改云原生API网关实例网络基本信息，例如带宽以及描述，只支持修改客户端公网/内网的信息。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyNetworkBasicInfo。
Version	是	String	公共参数，本接口取值：2020-12-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
GatewayId	是	String	云原生API网关实例ID。示例值：gateway-dde03767
GroupId	是	String	分组id 示例值：group-4se0czf7
NetworkType	是	String	网络类型： - Open 公网ipv4 - Open-IPv6 公网ipv6 - Internal 内网示例值：Open
Vip	是	String	ip地址示例值：132.0.0.1
InternetMaxBandwidthOut	否	Integer	公网出流量带宽[1,2048]Mbps 示例值：10
Description	否	String	负载均衡描述示例值：公网入口

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改网关实例网络基本信息

修改Kong客户端内网网络信息

输入示例

POST / HTTP/1.1
Host: tse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNetworkBasicInfo
<公共请求参数>

{
    "GatewayId": "gatway-dde03767",
    "GroupId": "group-4se0czf7",
    "NetworkType": "Open",
    "Vip": "172.10.10.1",
    "InternetMaxBandwidthOut": 1,
    "Description": "公网入口负载均衡"
}

输出示例

{
    "Response": {
        "RequestId": "ffadafb6-545d-461c-ad8c-baa26c0f8955"
    }
}

5. 开发者资源

腾讯云 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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.FailedOperation	操作失败。
FailedOperation.InternalError	操作失败，内部错误。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.InvalidParameterValue	无效的参数值。
InvalidParameterValue.UpdateError	无效请求参数导致更新失败。
MissingParameter.MissParameter	缺少参数。
OperationDenied.OperationDenied	不允许的操作。
ResourceNotFound.Forbidden	资源不存在不允许操作。
ResourceNotFound.InstanceNotFound	实例不存在。
ResourceNotFound.ResourceNotFound	资源不存在。
UnauthorizedOperation.UnauthorizedOperation	未授权的操作。

修改云原生API网关实例网络基本信息

本页目录：