Obtaining the Deployment Information About a Release Task Based on the Release Task ID

Function

This API is used to obtain the deployment information about a release task based on the release task ID.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the permission listed below is required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage::getReleasePlan	read	-	-	-	-

URI

GET /v3/{project_id}/cas/release-plans/{release_plan_id}/deploy-info

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID. See Obtaining a Project ID.
release_plan_id	Yes	String	Release task ID. See Obtaining the Release Task List.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default value: application/json;charset=utf8.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication.

Response

**Table 3** Response parameters
Parameter	Type	Description
id	String	Release task ID.
components	Array of objects	Component release information. See Table 4.

**Table 4** job_info
Parameter	Type	Description
job_id	String	Job ID.
status	String	Component status.
job_status	String	Job status.
name	String	Component name.
id	String	Component ID.
seq	String	Release batch.
version	String	Component version.
rollback_job_id	String	Rollback job ID.
start_time	Long	Start time of component release.
end_time	Long	End time of component release.
rollback_job_status	String	Rollback job status.
rollback_start_time	String	Start time of component rollback.
rollback_end_time	String	End time of component rollback.
fail_message	String	Failure message.
rollback_fail_message	String	Rollback failure message.

Example Request

None

Example Response

{
    "id": "716eda33-dbc6-47f3-953f-29119edd5e5c",
    "components": [
        {
            "job_id": "JOB6999c66d-cb39-4c46-9f98-893b704300e0",
            "status": "RUNNING",
            "job_status": "SUCCEEDED",
            "name": "sch",
            "id": "df49e875-000c-4d69-8f45-c4f384549e1b",
            "seq": 1,
            "version": "2024.0802.18390",
            "rollback_job_id": null,
            "start_time": 1722933924962,
            "end_time": 1722933950018,
            "rollback_job_status": null,
            "rollback_start_time": 0,
            "rollback_end_time": 0,
            "fail_message": null,
            "rollback_fail_message": null
        }
    ]
}