1. 接口描述
接口请求域名: apigateway.tencentcloudapi.com 。
修改后端通道
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyUpstream。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
UpstreamId | 是 | String | 后端通道唯一ID 示例值:upstream-0c96l2bo |
UpstreamName | 否 | String | 后端通道名字 示例值:upstream_a |
UpstreamDescription | 否 | String | 后端通道描述 示例值:description |
Scheme | 否 | String | 后端协议,取值范围:HTTP, HTTPS 示例值:HTTP |
UpstreamType | 否 | String | 后端访问类型,取值范围:IP_PORT, K8S 示例值:IP_PORT |
Algorithm | 否 | String | 负载均衡算法,取值范围:ROUND_ROBIN 示例值:ROUND_ROBIN |
UniqVpcId | 否 | String | VPC唯一ID 示例值:vpc-123456 |
Retries | 否 | Integer | 请求重试次数,默认3次 示例值:3 |
UpstreamHost | 否 | String | 网关转发到后端的 Host 请求头 示例值:example.com |
Nodes.N | 否 | Array of UpstreamNode | 后端节点列表 |
HealthChecker | 否 | UpstreamHealthChecker | 健康检查配置,目前只支持VPC通道 |
K8sService.N | 否 | Array of K8sService | 容器服务配置 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | ModifyUpstreamResultInfo | 返回修改后的后端通道信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改vpc通道信息
修改vpc通道信息
输入示例
https://apigateway.tencentcloudapi.com/?Action=ModifyUpstream
&UpstreamId=upstream-0c96l2bo
&Retries=4
&UpstreamName=test
&UpstreamHost=www.a.com
&UpstreamDescription=test
&<公共请求参数>
输出示例
{
"Response": {
"Result": {
"UpstreamId": "abc",
"UpstreamName": "abc",
"UpstreamDescription": "abc",
"Scheme": "abc",
"Algorithm": "abc",
"UniqVpcId": "abc",
"Retries": 1,
"Nodes": [
{
"VmInstanceId": "abc",
"Host": "abc",
"Port": 1,
"Weight": 1,
"Tags": [
"abc"
],
"Healthy": "abc",
"ServiceName": "abc",
"NameSpace": "abc",
"ClusterId": "abc",
"Source": "abc",
"UniqueServiceName": "abc"
}
],
"CreatedTime": "2020-09-22T00:00:00+00:00",
"HealthChecker": {
"EnableActiveCheck": true,
"EnablePassiveCheck": true,
"ActiveCheckHttpPath": "abc",
"ActiveCheckTimeout": 1,
"ActiveCheckInterval": 1,
"ActiveRequestHeader": [
{}
],
"UnhealthyTimeout": 1,
"HealthyHttpStatus": "abc",
"UnhealthyHttpStatus": "abc",
"TcpFailureThreshold": 1,
"TimeoutThreshold": 1,
"HttpFailureThreshold": 1
},
"UpstreamType": "abc",
"K8sServices": [
{
"Name": "abc",
"Weight": 0,
"ClusterId": "abc",
"Namespace": "abc",
"ServiceName": "abc",
"Port": 0,
"ExtraLabels": [
{
"Key": "abc",
"Value": "abc"
}
]
}
],
"UpstreamHost": "abc"
},
"RequestId": "abc"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
FailedOperation.OperateUpstream | 操作后端通道失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameterValue.InvalidUpstream | 当前后端通道不存在或者是无效状态。 |
InvalidParameterValue.InvalidVpcConfig | 无效vpc信息。 |
InvalidParameterValue.NotInOptions | 参数取值错误。当前值不在可选范围内。 |
InvalidParameterValue.RangeExceeded | 参数取值错误,不在参数范围内。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation | 操作不支持。 |