DescribeSessionImageVersion

Download PDF

Last updated: 2025-11-13 20:53:33

DescribeSessionImageVersion

Last updated: 2025-11-13 20:53:33

Download PDF

1. API Description

Domain name for API request: dlc.intl.tencentcloudapi.com.

This API is used to retrieve all built-in images of all minor versions under a specified major version.

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: DescribeSessionImageVersion.
Version	Yes	String	Common Params. The value used for this API: 2021-01-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-jakarta, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
DataEngineId	Yes	String	Engine Id.
FrameworkType	Yes	String	Framework type: machine-learning, python, spark-ml.

3. Output Parameters

Parameter Name	Type	Description
EngineSessionImages	Array of EngineSessionImage	Expands the image list. 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 Built-In Image

Current engine: DataEngine-b0jt6fvk
This example shows you how to choose machine-learning as the framework type.

Input Example

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

{
    "DataEngineId": "DataEngine-b0jt6fvk",
    "FrameworkType": "machine-learning"
}

Output Example

{
    "Response": {
        "EngineSessionImages": [
            {
                "SparkImageId": "123e4567-e89b-12d3-a456-426614174001",
                "SparkImageTag": "ccr.ccs.tencentyun.com/dlc_cloud/tensorflow:dev-v20241218",
                "SparkImageType": 1,
                "SparkImageVersion": "tensorflow-v2.18.0"
            },
            {
                "SparkImageId": "1a2b3c4d-5e6f-7g8h-9i0j-k1l2m3n4o5p6",
                "SparkImageTag": "ccr.ccs.tencentyun.com/dlc_cloud/scikit-learn:dev-v20241218",
                "SparkImageType": 1,
                "SparkImageVersion": "scikit-learn-v1.6.0"
            },
            {
                "SparkImageId": "98765432-10fe-bcd1-9a8b-0123456789ab",
                "SparkImageTag": "ccr.ccs.tencentyun.com/dlc_cloud/pytorch:dev-v20241218",
                "SparkImageType": 1,
                "SparkImageVersion": "pytorch-v2.5.1"
            }
        ],
        "RequestId": "c06478c4-bbc6-4cec-934b-6f9e2ff121ae"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation	The operation failed.
InternalError	An internal error occurred.
InternalError.InternalSystemException	The business system is abnormal. Please try again or submit a ticket to contact us.
InvalidParameter.InvalidConfigValueRegexpNotMatch	The specified task parameter Value does not conform to the rules.
InvalidParameter.ParameterNotFoundOrBeNone	The parameter is not found or empty.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud