Help Center/ CodeArts Deploy/ API Reference/ APIs/ Measuring Deployment Record/ Obtaining the Application Deployment Success Rate in a Specified Application
Updated on 2024-11-25 GMT+08:00

Obtaining the Application Deployment Success Rate in a Specified Application

Function

This API is used to obtain the application deployment success rate in a specified application.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

start_date

Yes

String

Left boundary (included) of the application deployment start time. Format: MMM DD, YYYY.

end_date

Yes

String

Right boundary (included) of the application deployment start time. The format is YYYY-MM-DD. The maximum range is one year.

task_ids

Yes

Array of strings

Application ID list

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

project_id

String

Project ID. For details, see Obtaining a Project ID.

project_name

String

Project name

start_date

String

Left boundary (included) of the application deployment start time. Format: MMM DD, YYYY.

end_date

String

Right boundary (included) of the application deployment start time. The format is YYYY-MM-DD. The maximum range is one year.

tasks_success_rate

Array of TaskSuccessRate objects

Application success rate list

Table 4 TaskSuccessRate

Parameter

Type

Description

task_id

String

Application ID

task_name

String

Application name

success_rate

String

Success rate

record_count

Integer

Number of deployment records

success_record_count

Integer

Number of successful deployment records

Example Requests

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

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

Example Responses

Status code: 200

OK: The request is successful.

{
  "project_id" : "89931e210b214b5892ea833712f0f5e0",
  "project_name" : "Happy",
  "start_date" : "2022-01-01",
  "end_date" : "2022-10-26",
  "tasks_success_rate" : [ {
    "task_id" : "5bf0a54f36b04ddda7b94470fee39307",
    "task_name" : "happy482 Health Test Through URLs",
    "success_rate" : "0",
    "record_count" : 8,
    "success_record_count" : 0
  }, {
    "task_id" : "b6d20b703ffe4a04bc68790ddabf6ab7",
    "task_name" : "happy486 Start/Stop Tomcat",
    "success_rate" : "14.29",
    "record_count" : 14,
    "success_record_count" : 2
  } ]
}

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

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.

Error Codes

See Error Codes.