1. 接口描述
此接口处于预下线状态 。
预计下线时间:2024-09-17 15:06:30
接口请求域名: iecp.tencentcloudapi.com 。
产品停售,预下线
获取应用模板列表
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeApplications。 |
Version | 是 | String | 公共参数,本接口取值:2021-09-14。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
NamePattern | 否 | String | 模糊搜索字符串 示例值:name |
Offset | 否 | Integer | 默认 0 示例值:0 |
Limit | 否 | Integer | 默认 20 示例值:20 |
Sort.N | 否 | Array of FieldSort | 仅支持对 DistributeTime 字段排序,ASC/DESC |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
ApplicationSet | Array of ApplicationTemplate | 详细列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 test
输入示例
POST / HTTP/1.1
Host: iecp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplications
<公共请求参数>
{
"NamePattern": "",
"Limit": "0",
"Offset": "0"
}
输出示例
{
"Response": {
"RequestId": "35d6452e-32df-4ced-9095-25a4baaa009e",
"TotalCount": 2,
"ApplicationSet": [
{
"Id": 100000,
"Name": "test",
"Source": 1,
"ManageUrl": "",
"DistributeTime": "2021-10-26 14:38:41",
"WorkloadKind": "Deployment"
},
{
"Id": 100001,
"Name": "test-garry",
"Source": 1,
"ManageUrl": "",
"DistributeTime": "2021-10-26 14:42:12",
"WorkloadKind": "StatefulSet"
}
]
}
}
示例2 test2
输入示例
POST / HTTP/1.1
Host: iecp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplications
<公共请求参数>
{
"NamePattern": "",
"Limit": "10",
"Offset": "0"
}
输出示例
{
"Response": {
"RequestId": "43681fb3-2af9-4e4a-8f0d-04fbeaf87079",
"TotalCount": 1,
"ApplicationSet": [
{
"Id": 100000,
"Name": "test",
"Source": 1,
"ManageUrl": "",
"DistributeTime": "2021-10-26 14:38:41",
"WorkloadKind": "Deployment"
}
]
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InternalError.DBError | 数据库异常。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.DuplicateName | 名字冲突。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |