查询容器列表
最近更新时间: 2024-09-03 18:49:49
1. 接口描述
接口请求域名： tcss.api3.cloud.sunhongs.com。
搜索查询容器列表
默认接口请求频率限制：20次/秒。
接口更新时间：2023-11-10 10:10:38。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeAssetContainerList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-11-01 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Limit | 否 | 否 | Uint64 | 此参数对外不可见。 需要返回的数量，默认为10，最大值为100 |
| Offset | 否 | 否 | Uint64 | 此参数对外不可见。 偏移量，默认为0。 |
| Filters | 否 | 否 | Array of AssetFilters | 此参数对外不可见。 过滤条件。 |
| <li>ContainerName - String - 是否必填：否 - 容器名称模糊搜索</li> | ||||
| <li>Status - String - 是否必填：否 - 容器运行状态筛选，0："created",1："running", 2："paused", 3："restarting", 4："removing", 5："exited", 6："dead" </li> | ||||
| <li>Runas - String - 是否必填：否 - 运行用户筛选</li> | ||||
| <li>ImageName- String - 是否必填：否 - 镜像名称搜索</li> | ||||
| <li>HostIP- string - 是否必填：否 - 主机ip搜索</li> | ||||
| <li>OrderBy - String 是否必填：否 -排序字段，支持：cpu_usage, mem_usage的动态排序 ["cpu_usage","+"] '+'升序、'-'降序</li> | ||||
| <li>NetStatus - String -是否必填: 否 - 容器网络状态筛选 normal isolated isolating isolate_failed restoring restore_failed</li> | ||||
| <li>PodID - String -是否必填: 否 - PodID筛选</li> | ||||
| <li>NodeUniqueID - String -是否必填: 否 - SuperNode筛选</li> | ||||
| <li>PodUid - String -是否必填: 否 - Pod筛选</li> | ||||
| <li>PodIP - String -是否必填: 否 - PodIP筛选</li> | ||||
| <li>NodeType - String -是否必填: 否 - 节点类型筛选:NORMAL:普通节点;SUPER:超级节点</li> | ||||
| By | 否 | 否 | String | 此参数对外不可见。 排序字段 |
| Order | 否 | 否 | String | 此参数对外不可见。 排序方式 asc,desc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | ContainerInfo | 容器列表 |
| TotalCount | Uint64 | 总数量 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InternalError | |
| ResourceNotFound | |
| InvalidParameter.ParsingError |