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 |
Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are supported. 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 |
Definition Start time. Format: yyyy-MM-dd. 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. Range 1970-01-01 ~ 2125-12-30 Default value N/A |
|
end_date |
Yes |
String |
Definition End time. Format: yyyy-MM-dd. 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. Range 1970-01-01 ~ 2125-12-30 Default value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition : User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used for Obtaining a User Token. Constraints: N/A. Value range: String. Max. 20,000 characters. Default value: N/A. |
|
Content-Type |
Yes |
String |
Definition Message body type or format. Constraints N/A Range N/A Default value application/json. |
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 |
Definition: Deployment duration. Format: HH:mm:ss. Value range: N/A. |
|
state |
String |
Definition: Last execution status of the application. Value range: |
|
operator |
String |
Definition Operator account name. 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 |
Definition Start time of an application deployment. Format: yyyy-MM-dd HH:mm:ss. Example: 2021-02-25 10:37:27. Range 1970-01-01 00:00:00 ~ 2125-12-30 11:59:59 |
|
nickname |
String |
Definition Operator nickname. Range String. 1 to 30 characters. |
|
end_time |
String |
Definition End time of an application deployment. Format: yyyy-MM-dd HH:mm:ss. Example: 2021-02-25 10:37:27. Range 1970-01-01 00:00:00 ~ 2125-12-30 11:59:59 |
|
release_id |
Long |
Parameter description: Deployment record sequence number. Value range: N/A |
|
type |
String |
Definition: Deployment type. Value range: |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code |
|
error_msg |
String |
Error description |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code |
|
error_msg |
String |
Error description |
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 code: 400
Bad Request
{
"error_code" : "Deploy.00015002",
"error_msg" : "Invalid request parameter."
}
Status code: 403
Forbidden
{
"error_code" : "Deploy.00011154",
"error_msg" : "You do not have permissions to perform this operation."
}
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsdeploy.v2.region.CodeArtsDeployRegion; import com.huaweicloud.sdk.codeartsdeploy.v2.*; import com.huaweicloud.sdk.codeartsdeploy.v2.model.*; public class ListDeployTaskHistoryByDateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>")) .build(); ListDeployTaskHistoryByDateRequest request = new ListDeployTaskHistoryByDateRequest(); request.withProjectId("{project_id}"); request.withId("{id}"); try { ListDeployTaskHistoryByDateResponse response = client.listDeployTaskHistoryByDate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsdeploy.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsDeployClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListDeployTaskHistoryByDateRequest() request.project_id = "{project_id}" request.id = "{id}" response = client.list_deploy_task_history_by_date(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsdeploy.NewCodeArtsDeployClient( codeartsdeploy.CodeArtsDeployClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListDeployTaskHistoryByDateRequest{} request.ProjectId = "{project_id}" request.Id = "{id}" response, err := client.ListDeployTaskHistoryByDate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK: The request is successful. |
|
400 |
Bad Request |
|
403 |
Forbidden |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot