Querying the Historical Deployment Records of a Specified Application in a Project by the Start Time and End Time
Function
This API is used to query the historical deployment records of a specified application in a project by the start time and end time.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/task/{id}/history
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Parameter description: Project ID. For details, see [Obtaining a Project ID] (CloudDeploy_api_0014.xml). Constraints: N/A Value range: The value consists of 32 characters. Only letters and digits are allowed. Default value: N/A |
id |
Yes |
String |
Parameter description: Deployment application ID. Constraints: N/A Value range: The value consists of 32 characters. Only letters and digits are allowed. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
page |
Yes |
Integer |
Parameter description: Page number, which means the query starts from this page. Constraints: N/A Value range: 1-99,999 Default value: N/A |
size |
Yes |
Integer |
Parameter description: Number of items displayed on each page. Constraints: N/A Value range: 1-100 Default value: N/A |
start_date |
Yes |
String |
Parameter description: Start time. The value format is yyyy-MM-dd. For example, 2022-03-16. Constraints: This parameter is used together with end_date. The value of end_date must be later than or equal to the value of start_date. The time range cannot exceed 30 days. Value range: N/A Default value: N/A |
end_date |
Yes |
String |
Parameter description: End time. The value format is yyyy-MM-dd. For example, 2022-04-15. Constraints: This parameter is used together with start_date. The value of end_date must be later than or equal to the value of start_date. The time range cannot exceed 30 days. Value range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Content-Type |
Yes |
String |
Message body type (format). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
Array of ExecuteRecordV2Body objects |
Parameter description: List of historical application deployment records. |
total_num |
Integer |
Parameter description: Total number of historical application deployment records between the start time and end time. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
duration |
String |
Parameter description: Deployment duration. Value range: N/A |
state |
String |
Parameter description: Application status. Value range: N/A |
operator |
String |
Parameter description: Operator username. Value range: N/A |
execution_id |
String |
Parameter description: Deployment record ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
start_time |
String |
Parameter description: Start time of application deployment. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A |
nickname |
String |
Parameter description: Operator nickname. Value range: N/A |
end_time |
String |
Parameter description: End time of application deployment. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A |
release_id |
Long |
Parameter description: Deployment record sequence number. Value range: N/A |
type |
String |
Parameter description: Deployment type. Value range:
|
Example Requests
https://{endpoint}/v2/5ab1363a143f46aa9959a4a8c2616589/task/ad9c1d60282544d2b5a380ea22539cf1/history?page=2&size=2&start_date=2022-03-16&end_date=2022-04-15
Example Responses
Status code: 200
OK: The request is successful.
{ "result" : [ { "duration" : "00:16:53", "state" : "succeeded", "type" : "install", "operator" : "devcloud_devcloud_l00490255_01", "execution_id" : "50f18ce454a64ea5a62a33d56617b831", "start_time" : "2022-04-15 15:03:24", "nickname" : "A/B Side Account", "end_time" : "2022-04-15 15:20:17", "release_id" : 20 }, { "duration" : "00:15:31", "state" : "failed", "type" : "install", "operator" : "devcloud_devcloud_l00490255_01", "execution_id" : "f757fbe93d35494ba0ff73b34e2f79aa", "start_time" : "2022-04-15 15:03:15", "nickname" : "A/B Side Account", "end_time" : "2022-04-15 15:18:46", "release_id" : 19 } ], "total_num" : 20 }
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.