文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 部署记录度量/ 获取指定应用的应用部署成功率
更新时间:2025-07-01 GMT+08:00
分享

获取指定应用的应用部署成功率

功能介绍

获取指定应用的应用部署成功率。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/tasks/metrics/success-rate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

start_date

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

end_date

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

task_ids

Array of strings

参数解释

任务id列表。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

project_id

String

参数解释

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

取值范围

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

project_name

String

参数解释

项目名称。

取值范围

长度为[3,128]个字符。

start_date

String

参数解释

部署应用开始时间范围的左边界(包含)。格式为yyyy-MM-dd。例如:2022-10-26。

取值范围

不涉及。

end_date

String

参数解释

部署应用开始时间范围的右边界(包含)。格式为yyyy-MM-dd。例如:2022-10-26。

取值范围

不涉及。

tasks_success_rate

Array of TaskSuccessRate objects

参数解释

应用的成功率列表。

表4 TaskSuccessRate

参数

参数类型

描述

task_id

String

参数解释

任务id。

取值范围

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

task_name

String

参数解释

应用名称。

取值范围

由中文字符、英文字母、数字及“_”、“-”组成,且长度为[3-128]个字符。

success_rate

String

参数解释

成功率,单位%。

取值范围

0-100。

record_count

Integer

参数解释

查询到的应用部署记录数。

取值范围

不涉及。

success_record_count

Integer

参数解释

成功的应用部署记录数。

取值范围

不涉及。

请求示例

https://{endpoint}/v2/89931e210b214b5892ea833712f0f5e0/tasks/metrics/success-rate

{
  "start_date" : "2022-01-01",
  "end_date" : "2022-10-26",
  "task_ids" : [ "5bf0a54f36b04ddda7b94470fee39307", "b6d20b703ffe4a04bc68790ddabf6ab7" ]
}

响应示例

状态码:200

OK 请求响应成功

{
  "project_id" : "89931e210b214b5892ea833712f0f5e0",
  "project_name" : "Happy",
  "start_date" : "2022-01-01",
  "end_date" : "2022-10-26",
  "tasks_success_rate" : [ {
    "task_id" : "5bf0a54f36b04ddda7b94470fee39307",
    "task_name" : "happy482URL健康测试",
    "success_rate" : "0",
    "record_count" : 8,
    "success_record_count" : 0
  }, {
    "task_id" : "b6d20b703ffe4a04bc68790ddabf6ab7",
    "task_name" : "happy486启动停止Tomcat",
    "success_rate" : "14.29",
    "record_count" : 14,
    "success_record_count" : 2
  } ]
}

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
48
49
50
51
52
53
54
55
56
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.*;

import java.util.List;
import java.util.ArrayList;

public class ListTaskSuccessRateSolution {

    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();
        ListTaskSuccessRateRequest request = new ListTaskSuccessRateRequest();
        request.withProjectId("{project_id}");
        TasksSuccessRateQuery body = new TasksSuccessRateQuery();
        List<String> listbodyTaskIds = new ArrayList<>();
        listbodyTaskIds.add("5bf0a54f36b04ddda7b94470fee39307");
        listbodyTaskIds.add("b6d20b703ffe4a04bc68790ddabf6ab7");
        body.withTaskIds(listbodyTaskIds);
        body.withEndDate("2022-10-26");
        body.withStartDate("2022-01-01");
        request.withBody(body);
        try {
            ListTaskSuccessRateResponse response = client.listTaskSuccessRate(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
33
34
35
36
37
38
39
40
# 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 = ListTaskSuccessRateRequest()
        request.project_id = "{project_id}"
        listTaskIdsbody = [
            "5bf0a54f36b04ddda7b94470fee39307",
            "b6d20b703ffe4a04bc68790ddabf6ab7"
        ]
        request.body = TasksSuccessRateQuery(
            task_ids=listTaskIdsbody,
            end_date="2022-10-26",
            start_date="2022-01-01"
        )
        response = client.list_task_success_rate(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
38
39
40
41
42
43
44
45
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.ListTaskSuccessRateRequest{}
	request.ProjectId = "{project_id}"
	var listTaskIdsbody = []string{
        "5bf0a54f36b04ddda7b94470fee39307",
	    "b6d20b703ffe4a04bc68790ddabf6ab7",
    }
	request.Body = &model.TasksSuccessRateQuery{
		TaskIds: listTaskIdsbody,
		EndDate: "2022-10-26",
		StartDate: "2022-01-01",
	}
	response, err := client.ListTaskSuccessRate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码

相关文档