Obtaining the Application Deployment Success Rate in a Specified Project
Function
This API is used to obtain the application deployment success rate in a specified project.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/metrics/success-rate
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
start_date |
Yes |
String |
Parameter description: Left boundary (included) of the application deployment start time range. The value format is yyyy-MM-dd. For example, 2022-01-01. 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 maximum time range is one year. Value range: N/A Default value: N/A |
end_date |
Yes |
String |
Parameter description: Right boundary (included) of the application deployment start time range. The value format is yyyy-MM-dd. For example, 2022-10-26. 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 maximum time range is one year. Value range: N/A Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
success_rate |
String |
Parameter description: Success rate. Value range: N/A |
project_id |
String |
Parameter description: Project ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
project_name |
String |
Parameter description: Project name. Value range: The value consists of 3 to 128 characters. |
start_date |
String |
Parameter description: Left boundary (included) of the application deployment start time range. The value format is yyyy-MM-dd. For example, 2022-10-26. Value range: N/A |
end_date |
String |
Parameter description: Right boundary (included) of the application deployment start time range. The value format is yyyy-MM-dd. For example, 2022-10-26. Value range: N/A |
task_count |
Integer |
Parameter description: Number of queried applications. Value range: N/A |
record_count |
Integer |
Parameter description: Number of queried application deployment records. Value range: N/A |
success_record_count |
Integer |
Parameter description: Number of successful application deployment records. Value range: N/A |
Example Requests
This API is used to obtain the deployment success rate of the target application in a specified period.
https://{endpoint}/v2/89931e210b214b5892ea833712f0f5e0/metrics/success-rate?start_date=2022-01-01&end_date=2022-10-26
Example Responses
Status code: 200
OK: The request is successful.
{ "success_rate" : "34.09", "project_id" : "89931e210b214b5892ea833712f0f5e0", "project_name" : "Happy", "start_date" : "2022-01-01", "end_date" : "2022-10-26", "task_count" : 8, "record_count" : 44, "success_record_count" : 15 }
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 |
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 ShowProjectSuccessRateSolution { 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(); ShowProjectSuccessRateRequest request = new ShowProjectSuccessRateRequest(); request.withProjectId("{project_id}"); try { ShowProjectSuccessRateResponse response = client.showProjectSuccessRate(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 |
# 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 = ShowProjectSuccessRateRequest() request.project_id = "{project_id}" response = client.show_project_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 |
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.ShowProjectSuccessRateRequest{} request.ProjectId = "{project_id}" response, err := client.ShowProjectSuccessRate(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.
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