文档中心>容器安全服务>API 文档>安全合规相关接口>安全合规查询某个资产的详情

安全合规查询某个资产的详情

最近更新时间:2024-10-31 02:10:15

我的收藏

1. 接口描述

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

查询某个资产的详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeComplianceAssetDetailInfo。
Version String 公共参数,本接口取值:2020-11-01。
Region String 公共参数,此参数为可选参数。
CustomerAssetId Integer 客户资产ID。
示例值:111
AssetType String 资产类型
  • ASSET_CONTAINER Docker容器
  • ASSET_IMAGE Docker镜像
  • ASSET_HOST Docker主机
  • ASSET_K8S Kubernetes
  • ASSET_CONTAINERD Containerd主机
  • ASSET_CONTAINERD_CONTAINER Containerd容器

  • 示例值:ASSET_CONTAINER

    3. 输出参数

    参数名称 类型 描述
    AssetDetailInfo ComplianceAssetDetailInfo 某资产的详情。
    ContainerDetailInfo ComplianceContainerDetailInfo 当资产为容器时,返回此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    ImageDetailInfo ComplianceImageDetailInfo 当资产为镜像时,返回此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    HostDetailInfo ComplianceHostDetailInfo 当资产为主机时,返回此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    K8SDetailInfo ComplianceK8SDetailInfo 当资产为K8S时,返回此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 请求资产详细信息

    请求资产详细信息

    输入示例

    POST / HTTP/1.1
    Host: tcss.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeComplianceAssetDetailInfo
    <公共请求参数>
    
    {
        "CustomerAssetId": 2202462,
        "AssetType": "ASSET_CONTAINER"
    }

    输出示例

    {
        "Response": {
            "AssetDetailInfo": {
                "AssetCreateTime": "2024-07-24 11:32:45",
                "AssetName": "my-elasticsearch-container",
                "AssetStatus": "ASSET_STOPPED",
                "AssetType": "ASSET_CONTAINER",
                "CheckResult": "RESULT_FAILED",
                "CheckStatus": "CHECK_FINISHED",
                "CustomerAssetId": 2202462,
                "FailedPolicyItemCount": 7,
                "HostIP": "172.16.49.104",
                "HostName": "VM-49-104-centos",
                "LastCheckTime": "2024-07-24 11:17:15",
                "NodeName": "云镜漏洞测试机-目标机器",
                "PassedPolicyItemCount": 17
            },
            "ContainerDetailInfo": {
                "ContainerId": "e822238a07e0",
                "PodName": ""
            },
            "HostDetailInfo": {
                "ContainerdVersion": "",
                "DockerVersion": "",
                "K8SVersion": ""
            },
            "ImageDetailInfo": {
                "ImageId": "",
                "ImageName": "",
                "ImageTag": "",
                "Repository": ""
            },
            "K8SDetailInfo": {
                "ClusterName": "",
                "ClusterVersion": ""
            },
            "RequestId": "ae46673b-3930-4874-9144-a514653d232c"
        }
    }

    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 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.MissingParameter 缺少必须参数。
    OperationDenied 操作被拒绝。
    RequestLimitExceeded 请求的次数超过了频率限制。