Querying the Scheduled Plan for Adding or Deleting a Logical Cluster

Function

This API is used to query the scheduled plan for adding or deleting a logical cluster. There are up to 20 data records in a plan.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/clusters/{cluster_id}/logical-cluster-plans

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
cluster_id	Yes	String	Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints N/A Range N/A Default Value N/A
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
plans	Array of LogicalClusterPlanVo objects	Definition Object list of the plan for adding or deleting a logical cluster. A maximum of 20 records can be returned. Range N/A

**Table 3** LogicalClusterPlanVo
Parameter	Type	Description
id	String	Definition ID of the plan for adding or deleting a logical cluster. Range N/A
logical_cluster_name	String	Definition Logical cluster name. Range N/A
node_num	Integer	Definition Number of nodes in the logical cluster. Range N/A
plan_type	String	Definition Plan type. The value can be once or periodicity. Range N/A
status	String	Definition Status of the plan for adding or deleting a logical cluster. Range running waiting deleted finished disabled failed
start_time	String	Definition Start time of the plan for adding or deleting a logical cluster. Range N/A
end_time	String	Definition End time of the plan for adding or deleting a logical cluster. Range N/A
update_time	String	Definition Time when the plan for adding or deleting a logical cluster is updated. Range N/A
user	String	Definition User bound to the plan for adding or deleting a logical cluster. Range N/A
actions	Array of LogicalClusterPlanActions objects	Definition Task information. Range N/A

**Table 4** LogicalClusterPlanActions
Parameter	Type	Description
next_fire_time	String	Definition Time when the next plan will be triggered. Range N/A
failed_reason	String	Definition Failure cause. Range N/A
id	String	Definition Task ID. Range N/A
type	String	Definition Type. Range create delete
strategy	String	Definition Period information. Cron expression, for example, *0 0 0? 3. Range** N/A
status	String	Definition Task status. Range running, waiting, deleted, finished, disabled, or failed
pre_fire_time	String	Definition Time when the previous plan was triggered. Range N/A

Example Requests

Query the scheduled plan for adding or deleting a logical cluster.

GET https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/logical-cluster-plans

Example Responses

Status code: 200

Scheduled plan for adding or deleting logical a cluster queried.

{
  "plans" : [ {
    "id" : "5f70f6ba-4683-4cae-a5e6-3b05a310f6f9",
    "status" : "finished",
    "user" : null,
    "actions" : [ {
      "strategy" : "1740134866526",
      "status" : "finished",
      "next_fire_time" : null,
      "failed_reason" : null,
      "id" : "b33f5783-8d9c-4ec6-9249-ccfd9186d105",
      "type" : "create"
    } ],
    "logical_cluster_name" : "LC_0221_02",
    "node_num" : 3,
    "plan_type" : "once",
    "start_time" : "2025-02-21T10:47:48Z",
    "end_time" : "2025-02-21T11:03:38Z",
    "update_time" : "2025-02-21T11:03:38Z"
  } ]
}

Status Codes

Status Code	Description
200	Scheduled plan for adding or deleting logical a cluster queried.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.