有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: tem.tencentcloudapi.com 。

修改服务访问方式列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyApplicationService。
Version String 公共参数,本接口取值:2021-07-01。
Region String 公共参数,详见产品支持的 地域列表
ApplicationId String 服务id
示例值:1
EnvironmentId String 环境ID
示例值:1
SourceChannel Integer 来源渠道
示例值:0
Service EksService 全量访问方式设置
示例值:1
Data ServicePortMapping 单条访问方式设置
示例值:{}

3. 输出参数

参数名称 类型 描述
Result Boolean 是否成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改服务访问方式列表

输入示例

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

{
    "SourceChannel": 0,
    "ApplicationId": "xx",
    "Service": {
        "ApplicationName": "xx",
        "ExternalIp": "xx",
        "Name": "xx",
        "ApplicationId": "xx",
        "AllIpDone": true,
        "PortMappings": [
            {
                "Protocol": "xx",
                "ServiceName": "xx",
                "TargetPort": 0,
                "Port": 0
            }
        ],
        "Yaml": "xx",
        "LoadBalanceId": "xx",
        "ServicePortMappingList": [
            {
                "ExternalIp": "xx",
                "VpcId": "xx",
                "PortMappingItemList": [
                    {
                        "Protocol": "xx",
                        "TargetPort": 0,
                        "Port": 0
                    }
                ],
                "Yaml": "xx",
                "LoadBalanceId": "xx",
                "ServiceName": "xx",
                "ClusterIp": "xx",
                "SubnetId": "xx",
                "Type": "xx",
                "Ports": [
                    0
                ]
            }
        ],
        "VersionName": "xx",
        "ClusterIp": [
            "xx"
        ],
        "SubnetId": "xx",
        "Type": "xx",
        "Ports": [
            0
        ],
        "EnableRegistryNextDeploy": 0,
        "FlushAll": true
    },
    "EnvironmentId": "xx"
}

输出示例

{
    "Response": {
        "Result": true,
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError.DefaultInternalError 服务器繁忙,请稍后再试。
InvalidParameter.ApplicationAccessServiceReachMaximum 应用访问配置服务数量达到上限。
InvalidParameter.LBServiceCannotSupportTcpUdpSameTime LB类型服务不能同时支持TCP和UDP。
InvalidParameter.MustProvidePortMappingRules 必须提供PortMapping规则。
InvalidParameter.ServiceNameNotValid 服务名不符合规范。
InvalidParameter.ServiceUseReserveSuffix 服务名使用了保留后缀。
InvalidParameter.TooManyPortMappingRules PortMapping规则数量超过限制。
InvalidParameterValue.ApplicationServiceNotFound 没有找到该访问方式。
InvalidParameterValue.InvalidEksServiceType 访问类型不支持。
InvalidParameterValue.PortIsReserved 服务端口是保留端口。
ResourceNotFound.ServiceNotFound 找不到应用。
ResourceNotFound.ServiceRunningVersionNotFound 找不到运行的服务实例。
ResourceNotFound.VersionNamespaceNotFound 找不到版本对应的环境。