Help Center/ Cloud Search Service/ API Reference/ APIs/ Cluster Management/ Obtaining the ID of the Target Image to Upgrade To

Updated on 2025-01-23 GMT+08:00

View PDF

Obtaining the ID of the Target Image to Upgrade To

Function

This API is used to obtain the ID of an image that can be upgraded in the current cluster.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Options: For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Default value: N/A
cluster_id	Yes	String	Parameter description: ID of the cluster to be upgraded. Constraints: N/A Options: For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Default value: N/A
upgrade_type	Yes	String	Parameter description: Upgrade type. Constraints: N/A Options: same: same-version upgrade. cross: cross-version upgrade. cross-engine: cross-engine upgrade. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
needUploadUpgradePlugin	Boolean	Parameter description: Whether to upload the plug-in of the target version.
imageInfoList	Array of GetTargetImageIdDetail objects	Parameter description: Image details.

**Table 3** GetTargetImageIdDetail
Parameter	Type	Description
id	String	Parameter description: ID of an image that can be upgraded.
displayName	String	Parameter description: Name of an image that can be upgraded.
imageDesc	String	Parameter description: Image description.
datastoreType	String	Parameter description: Image engine type.
datastoreVersion	String	Parameter description: Image engine version.
priority	Integer	Parameter description: Priority of the target image. A larger value indicates a higher priority.

Example Requests

GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/target/cross/images

{
  "needUploadUpgradePlugin" : false,
  "imageInfoList" : [ ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "needUploadUpgradePlugin" : false,
  "imageInfoList" : [ ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. The client should not repeat the request without modifications.
403	Request rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

Status Code

Description

200

Request succeeded.

400

Invalid request.

The client should not repeat the request without modifications.

403

Request rejected.

The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.