1. 接口描述
接口请求域名: apis.tencentcloudapi.com 。
修改服务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyService。 |
| Version | 是 | String | 公共参数,本接口取值:2024-08-01。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceID | 否 | String | 实例 示例值:ins-a7af1980 |
| Name | 否 | String | 名称 示例值:test_name |
| Description | 否 | String | 描述 示例值:test desc |
| LabelIDs.N | 否 | Array of String | 标签 示例值:["lab-xxxxxxxx"] |
| CategoryIDs.N | 否 | Array of String | 目录 示例值:["cat-xxxxxxxx"] |
| TargetSelect | 否 | String | 负载方式 示例值:random |
| PubPath | 否 | String | 公开路径 示例值:/bbb |
| RequestMethod | 否 | String | 请求方法 示例值:any |
| HttpProtocolType | 否 | String | 是否https 示例值:http |
| CheckTargetCertsError | 否 | Boolean | 证书检查 示例值:true |
| HttpProtocolVersion | 否 | String | http协议类型 示例值:1.1 |
| Versions.N | 否 | Array of VersionDTO | 版本号 |
| TargetPath | 否 | String | 目标路径 示例值:/ |
| RequestParamsValidatorStatus | 否 | Boolean | 入参 示例值:true |
| RequestParamsValidatorJsonInfoT | 否 | String | 入参 示例值:{"Body":{"Type":"object"},"Query":{"Type":"object"},"Header":{"Type":"object"}} |
| ResponseParamsValidatorStatus | 否 | Boolean | 出参 示例值:true |
| ResponseParamsValidatorJsonInfoT | 否 | String | 出参 示例值:{"Body":{"Type":"object"},"Query":{"Type":"object"},"Header":{"Type":"object"}} |
| InvokeLimitConfigStatus | 否 | Boolean | 流量控制 示例值:true |
| InvokeLimitConfig | 否 | InvokeLimitConfigDTO | 流量控制 |
| HealthCheckStatus | 否 | Boolean | 健康检查 示例值:true |
| HealthCheckConfig | 否 | HealthCheckConfigDTO | 健康检查 |
| SourceTypeStatus | 否 | Boolean | 格式转换 示例值:true |
| SourceTypeConfig | 否 | SourceTypeConfigDTO | 格式转换 |
| IpWhiteStatus | 否 | Boolean | IP白名单 示例值:true |
| IpWhiteList.N | 否 | Array of String | IP白名单 示例值:["127.0.0.1"] |
| IpBlackStatus | 否 | Boolean | IP黑名单 示例值:true |
| IpBlackList.N | 否 | Array of String | IP黑名单 示例值:["127.0.0.1"] |
| PluginConfigs.N | 否 | Array of PluginConfigDTO | 插件 |
| ID | 否 | String | 服务ID 示例值:svr-b9027f2d |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改服务
输入示例
POST / HTTP/1.1
Host: apis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyService
<公共请求参数>
{
"InstanceID": "ins-a7af1980",
"Name": "copyofcopyofcopyofbbb",
"PaasID": "app-be27914b",
"Description": "test desc",
"LabelIDs": [],
"CategoryIDs": [],
"AuthType": "none",
"SignType": "sha256",
"LoginTypes": [],
"TargetSelect": "random",
"PubPath": "/bbb",
"RequestMethod": "any",
"HttpProtocolType": "http",
"CheckTargetCertsError": false,
"HttpProtocolVersion": "1.1",
"Versions": [],
"TargetPath": "/",
"RequestParamsValidatorStatus": false,
"RequestParamsValidatorJsonInfoT": "{\"Body\":{\"Type\":\"object\"},\"Query\":{\"Type\":\"object\"},\"Header\":{\"Type\":\"object\"}}",
"ResponseParamsValidatorStatus": false,
"ResponseParamsValidatorJsonInfoT": "{\"Body\":{\"Type\":\"object\"},\"Query\":{\"Type\":\"object\"},\"Header\":{\"Type\":\"object\"}}",
"InvokeLimitConfigStatus": false,
"InvokeLimitConfig": {
"Type": "tokenBucket",
"TokenBucketMaxNum": 20000,
"TokenBucketRate": 1,
"FunnelMaxNum": 20000,
"FunnelRate": 1,
"SlidingWindowMaxNum": 20000,
"SlidingWindowSize": 1,
"TimeWindow": 20000,
"TimeWindowInterval": 1
},
"HealthCheckStatus": false,
"HealthCheckConfig": {
"HealthCheckPath": "",
"ValidHealthCheckStatusCode": [
200
],
"HealthCheckTimeout": 0
},
"SourceTypeStatus": false,
"SourceTypeConfig": {
"ReqSourceType": "",
"ReqTargetType": "",
"ResSourceType": "",
"ResTargetType": ""
},
"IpWhiteStatus": false,
"IpWhiteList": [],
"IpBlackStatus": false,
"IpBlackList": [],
"PluginConfigs": [],
"ID": "svr-b9027f2d"
}
输出示例
{
"Response": {
"RequestId": "b9ed80fd-bdc8-428b-977a-32c7f0a0ca0c"
}
}
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: 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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。