文档中心>物联网边缘计算平台>API 文档>边缘单元相关接口>查询边缘单元指定Grid下的部署应用列表

查询边缘单元指定Grid下的部署应用列表

最近更新时间:2024-11-06 01:41:21

我的收藏

1. 接口描述

此接口处于预下线状态 。

预计下线时间:2025-02-03 15:33:36

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

产品下线

查询边缘单元指定Grid下的部署应用列表

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeEdgeUnitDeployGridItem。
Version String 公共参数,本接口取值:2021-09-14。
Region String 公共参数,本接口不需要传递此参数。
EdgeUnitId Integer 边缘单元ID
示例值:1
GridName String Grid名称
示例值:grid-123
WorkloadKind String 负载类型(StatefulSetGrid|DeploymentGrid)
示例值:DeploymentGrid
Namespace String 命名空间,默认default
示例值:default
Order String 排序,默认ASC
示例值:ASC

3. 输出参数

参数名称 类型 描述
TotalCount Integer 记录总数
示例值:100
DeploySet Array of GridItemInfo Grid部署列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询边缘单元指定Grid下的部署列表

输入示例

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

{
    "EdgeUnitId": 8367274,
    "GridName": "logo-dg-privileged1111",
    "Namespace": "default",
    "WorkloadKind": "DeploymentGrid",
    "Order": "ASC"
}

输出示例

{
    "Response": {
        "RequestId": "5ebf13a2-f925-4ba7-adff-ddbc21d355e3",
        "TotalCount": 2,
        "DeploySet": [
            {
                "Name": "logo-dg-privileged1111-logofox",
                "Replicas": 1,
                "AvailableReplicas": 1,
                "StartTime": "2021-07-06 10:43:00",
                "WorkloadKind": "Deployment"
            },
            {
                "Name": "logo-dg-privileged1111-dev005",
                "Replicas": 1,
                "AvailableReplicas": 1,
                "StartTime": "2021-07-06 14:03:46",
                "WorkloadKind": "Deployment"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.DBError 数据库异常。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DuplicateName 名字冲突。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。