tencent cloud

PrevNext

피드백

키워드를 검색하세요

Recent Pages

문서
문서

DescribeImageFromFamily

마지막 업데이트 시간:2024-10-22 19:34:08

1. API Description

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

This API is used to view information about available images within an image family.

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: DescribeImageFromFamily.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ImageFamily No String Image family

3. Output Parameters

Parameter Name Type Description
Image Image Image information. Null is returned when there is no available image.
Note: This field may return null, indicating that no valid value is found.
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 image information of an Image Family

Input Example

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageFromFamily
<common request parameters>

{
    "ImageFamily": "business-daily-update"
}

Output Example

{
    "Response": {
        "Image": {
            "ImageId": "abc",
            "OsName": "abc",
            "ImageType": "abc",
            "CreatedTime": "2020-09-22T00:00:00+00:00",
            "ImageName": "abc",
            "ImageDescription": "abc",
            "ImageSize": 0,
            "Architecture": "abc",
            "ImageState": "abc",
            "Platform": "abc",
            "ImageCreator": "abc",
            "ImageSource": "abc",
            "SyncPercent": 0,
            "IsSupportCloudinit": true,
            "SnapshotSet": [
                {
                    "SnapshotId": "abc",
                    "DiskUsage": "abc",
                    "DiskSize": 0
                }
            ],
            "Tags": [
                {
                    "Key": "abc",
                    "Value": "abc"
                }
            ],
            "LicenseType": "abc",
            "ImageFamily": "business-daily-update",
            "ImageDeprecated": false
        },
        "RequestId": "5908394c-5b3f-42e0-a537-8410553890a5"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
개인정보 처리방침서비스 약관쿠키 정책