文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 应用管理/ 根据开始时间和结束时间查询项目下指定应用的历史部署记录列表
更新时间:2024-08-01 GMT+08:00
分享

根据开始时间和结束时间查询项目下指定应用的历史部署记录列表

功能介绍

根据开始时间和结束时间查询项目下指定应用的历史部署记录列表。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/task/{id}/history

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目id,获取方式请参见获取项目id

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

id

String

参数解释

部署任务id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

page

Integer

参数解释

分页页码, 表示从此页开始查询。

约束限制

不涉及。

取值范围

1-99999

默认取值

不涉及。

size

Integer

参数解释

每页显示的条目数量。

约束限制

不涉及。

取值范围

1-100

默认取值

不涉及。

start_date

String

参数解释

区间开始时间。格式为yyyy-MM-dd。例如:2022-03-16。

约束限制

与end_date配合使用,end_date需大于等于start_date,开始时间和结束时间间隔不能超过30天。

取值范围

不涉及。

默认取值

不涉及。

end_date

String

参数解释

区间结束时间。格式为yyyy-MM-dd。例如:2022-04-15。

约束限制

与start_date配合使用,end_date需大于等于start_date,开始时间和结束时间间隔不能超过30天。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

Content-Type

String

消息体的类型(格式),下方类型可任选其一使用:

application/json;charset=utf-8

application/json

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

Array of ExecuteRecordV2Body objects

参数解释

应用历史部署记录列表。

total_num

Integer

参数解释

开始时间和结束时间内应用历史部署记录总数。

取值范围

不涉及。

表5 ExecuteRecordV2Body

参数

参数类型

描述

duration

String

参数解释

部署用时。

取值范围

不涉及。

state

String

参数解释

应用状态。

取值范围

不涉及。

operator

String

参数解释

操作人用户名。

取值范围

不涉及。

execution_id

String

参数解释

部署记录id。

取值范围

由英文字母、数字组成,且长度为32个字符。

start_time

String

参数解释

部署应用的开始时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。

取值范围

不涉及。

nickname

String

参数解释

操作人昵称。

取值范围

不涉及。

end_time

String

参数解释

部署应用的结束时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。

取值范围

不涉及。

release_id

Long

参数解释

部署记录序列号。

取值范围

不涉及。

type

String

参数解释

部署类型。

取值范围

  • install: 安装部署

请求示例

https://{endpoint}/v2/5ab1363a143f46aa9959a4a8c2616589/task/ad9c1d60282544d2b5a380ea22539cf1/history?page=2&size=2&start_date=2022-03-16&end_date=2022-04-15

响应示例

状态码: 200

OK 请求响应成功

{
  "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" : "AB边账号",
    "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" : "AB边账号",
    "end_time" : "2022-04-15 15:18:46",
    "release_id" : 19
  } ],
  "total_num" : 20
}

SDK代码示例

SDK代码示例如下。

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)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码

相关文档