tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAssetImageRegistryDetail

Last updated: 2024-07-22 11:08:38

    1. API Description

    Domain name for API request: tcss.tencentcloudapi.com.

    This API is used to query the image repository details.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeAssetImageRegistryDetail.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    Id No Integer List of repository IDs
    ImageId No String Image ID

    3. Output Parameters

    Parameter Name Type Description
    ImageDigest String Image digest
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageRepoAddress String Image address
    Note: This field may return null, indicating that no valid values can be obtained.
    RegistryType String Image type
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageName String Repository name
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageTag String Image tag
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanTime String Scan time
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanStatus String Scanning status
    Note: This field may return null, indicating that no valid values can be obtained.
    VulCnt Integer Number of vulnerabilities
    Note: This field may return null, indicating that no valid values can be obtained.
    VirusCnt Integer Number of viruses and trojans
    Note: This field may return null, indicating that no valid values can be obtained.
    RiskCnt Integer Number of risky behaviors
    Note: This field may return null, indicating that no valid values can be obtained.
    SentiveInfoCnt Integer Number of sensitive data items
    Note: This field may return null, indicating that no valid values can be obtained.
    OsName String Image system
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanVirusError String Trojan scan error
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanVulError String Vulnerability scan error
    Note: This field may return null, indicating that no valid values can be obtained.
    LayerInfo String Layer file information
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceId String Instance ID
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceName String Instance name
    Note: This field may return null, indicating that no valid values can be obtained.
    Namespace String Namespace
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanRiskError String High-risk scan error
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanVirusProgress Integer Trojan scanning progress
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanVulProgress Integer Vulnerability scanning progress
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanRiskProgress Integer Sensitive data scanning progress
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanRemainTime Integer Remaining scan time in seconds
    Note: This field may return null, indicating that no valid values can be obtained.
    CveStatus String CVE scanning status
    Note: This field may return null, indicating that no valid values can be obtained.
    RiskStatus String High-risk scanning status
    Note: This field may return null, indicating that no valid values can be obtained.
    VirusStatus String Trojan scanning status
    Note: This field may return null, indicating that no valid values can be obtained.
    Progress Integer Overall progress
    Note: This field may return null, indicating that no valid values can be obtained.
    IsAuthorized Integer Licensing status
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageSize Integer Image size
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageId String Image ID
    Note: This field may return null, indicating that no valid values can be obtained.
    RegistryRegion String Image region
    Note: This field may return null, indicating that no valid values can be obtained.
    ImageCreateTime Timestamp ISO8601 Image creation time
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Viewing the details of a repository image

    Input Example

    POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetImageRegistryDetail
<Common request parameters>

{
    "Id": "5427"
}

    Output Example

    {
    "Response": {
        "RequestId": "acc92f01-ee14-4eec-a1b6-e78d3ea0b7e9",
        "ImageDigest": "sha256:615475135bb705517e749767a28f6bd57199008d3e9b688efa0f73a8befccc97",
        "ImageId": "sha256:e68ba1280908f76a9e22a813b9ea0c7358e9bcf0ed616fddf88dad557e33d1ca",
        "RegistryType": "ccr",
        "ImageRepoAddress": "ccr.ccs.tencentyun.com/yunding/person1",
        "InstanceId": "",
        "InstanceName": "ccr-default",
        "Namespace": "yunding",
        "ImageName": "person1",
        "ImageTag": "v1",
        "ImageSize": 74866818,
        "ScanTime": "2022-01-14T21:03:19+08:00",
        "ScanStatus": "SCANNED",
        "Progress": 100,
        "VulCnt": 172,
        "VirusCnt": 0,
        "RiskCnt": 1,
        "SentiveInfoCnt": 1,
        "OsName": "linux",
        "ScanVirusError": "",
        "ScanVulError": "",
        "ScanRiskError": "",
        "ScanVirusProgress": 0,
        "ScanVulProgress": 100,
        "ScanRiskProgress": 100,
        "ScanRemainTime": 0,
        "CveStatus": "SCANNED",
        "RiskStatus": "SCANNED",
        "VirusStatus": "NOT_SCAN",
        "IsAuthorized": 1,
        "LayerInfo": "#2020-06-17 00:22:24.918233762 +0000 UTC\n\n/bin/sh -c #(nop) ADD file:84700c11fcc969ac08ef25f115513d76c7b72a4118c01fbc86ef0a6056fdebeb in / \n\n#2020-06-17 00:22:25.276021438 +0000 UTC\n\n/bin/sh -c #(nop)  LABEL org.label-schema.schema-version=1.0 org.label-schema.name=CentOS Base Image org.label-schema.vendor=CentOS org.label-schema.license=GPLv2 org.label-schema.build-date=20200611\n\n#2020-06-17 00:22:25.47282687 +0000 UTC\n\n/bin/sh -c #(nop)  CMD [\"/bin/bash\"]\n\n#2020-12-18 10:06:01.1576746 +0000 UTC\n\n/bin/sh -c echo \"RSYNC_PASSWORD='xxx' rsync\"\n\n",
        "RegistryRegion": "default",
        "ImageCreateTime": "2020-12-25T16:40:39+08:00"
    }
}

    Example2 Querying the details of an image repository

    Input Example

    POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetImageRegistryDetail
<Common request parameters>

{
    "Id": 3421599
}

    Output Example

    {
    "Response": {
        "RequestId": "xxx",
        "ImageDigest": "sha256:8d8faaa36c253a8745c392fc71640757d29a5f026fc0e44bb9c98d56544f5175",
        "ImageId": "sha256:bb804a9c85d7199b8fd6a0c1a34ef1d049689604046fc5ce1ee6b968de78281b",
        "RegistryType": "ccr",
        "ImageRepoAddress": "hkccr.ccs.tencentyun.com/mhzou/mhccrxg",
        "InstanceId": "",
        "InstanceName": "ccr-ap-hongkong",
        "Namespace": "mhzou",
        "ImageName": "mhccrxg",
        "ImageTag": "mhccrxg1",
        "ImageSize": 8544764,
        "ScanTime": "2022-01-19T22:58:23+08:00",
        "ScanStatus": "SCANNED",
        "Progress": 100,
        "VulCnt": 2425,
        "VirusCnt": 0,
        "RiskCnt": 0,
        "SentiveInfoCnt": 0,
        "OsName": "linux",
        "ScanVirusError": "",
        "ScanVulError": "",
        "ScanRiskError": "",
        "ScanVirusProgress": 0,
        "ScanVulProgress": 100,
        "ScanRiskProgress": 100,
        "ScanRemainTime": 0,
        "CveStatus": "SCANNED",
        "RiskStatus": "SCANNED",
        "VirusStatus": "NOT_SCAN",
        "IsAuthorized": 1,
        "LayerInfo": "xxx",
        "RegistryRegion": "ap-hongkong",
        "ImageCreateTime": "1900-01-01T00:00:00+00:00"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter The parameter is incorrect.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy