Obtaining Details About a Single Rule
Function
This API is used to query details about a single rule.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{domain_id}/rules/{rule_id}/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Definition: Tenant ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
rule_id |
Yes |
String |
Definition: Rule ID, which is the unique identifier of a rule. Obtain the rule ID by calling the API for obtaining rules by page. data.id indicates the rule ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. 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 forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Rule ID. Value range: The value consists of 32 characters, including digits and letters. |
type |
String |
Definition: Rule type. Value range:
|
name |
String |
Definition: Rule name. Value range: N/A |
is_valid |
Boolean |
Definition: Whether the rule is valid. Value range: true: valid; false: invalid |
version |
String |
Definition: Rule version. Value range: N/A |
plugin_id |
String |
Definition: Extension ID. Value range: N/A |
plugin_name |
String |
Definition: Extension name. Value range: N/A |
plugin_version |
String |
Definition: Extension version number. Value range: N/A |
creator |
String |
Definition: Rule creator. Value range: N/A |
create_time |
String |
Definition: Time when a rule was created. Value range: N/A |
updater |
String |
Definition: User who last updated the rule. Value range: N/A |
update_time |
String |
Definition: Time when the rule was last updated. Value range: N/A |
content |
Array of RuleContent objects |
Definition: Rule attributes. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
group_name |
String |
Definition: Group name. Constraints: N/A Value range: N/A Default value: N/A |
can_modify_when_inherit |
Boolean |
Definition: Whether the threshold of the inherited sub-policy can be modified. Constraints: N/A Value range: N/A Default value: N/A |
properties |
Array of RuleProperty objects |
Definition: Rule attributes. Constraints: N/A Value range: N/A Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition: Attribute key. Constraints: N/A Value range: N/A Default value: N/A |
type |
String |
Definition: Type. Constraints: N/A Value range: N/A Default value: N/A |
name |
String |
Definition: Displayed name. Constraints: N/A Value range: N/A Default value: N/A |
operator |
String |
Definition: Comparison operator. Constraints: N/A Value range:
Default value: N/A |
value |
String |
Definition: Attribute value. Constraints: N/A Value range: N/A Default value: N/A |
value_type |
String |
Definition: Data type. Constraints: N/A Value range:
Default value: N/A |
is_valid |
Boolean |
Definition: Attribute enabled or not. Constraints: N/A Value range:
Default value: false. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A |
error_msg |
String |
Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A |
error_msg |
String |
Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A |
error_msg |
String |
Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A |
error_msg |
String |
Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A |
Example Requests
GET http://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/865b4c2d616b46ab890fff056a6f7e05/detail
Example Responses
Status code: 200
Request succeeded.
{ "id" : "865b4c2d616b46ab890fff056a6f7e05", "type" : "Build", "name" : "New Rule-20231020103003", "version" : "e2db2a63b3064252874b1b5a8571e2be", "plugin_id" : "official_devcloud_cloudBuild", "plugin_name" : "official_devcloud_cloudBuild", "plugin_version" : "0.0.15", "content" : [ { "group_name" : "MavenUnitTest", "can_modify_when_inherit" : true, "properties" : [ { "key" : "build.PassRatio", "type" : "judge", "name" : "PassRatio", "value_type" : "float", "value" : "0.1", "operator" : "=" }, { "key" : "build.TotalCases", "type" : "judge", "name" : "TotalCases", "value_type" : "float", "value" : "0.1", "operator" : "=" }, { "key" : "build.CoverageRatio", "type" : "judge", "name" : "CoverageRatio", "value_type" : "float", "value" : "0.1", "operator" : "=" } ] } ], "creator" : "847a5317086c41798469d0868535943a", "create_time" : "2023-10-20T10:30:20", "updater" : "847a5317086c41798469d0868535943a", "update_time" : "2023-10-20T10:30:20" }
SDK Sample Code
The SDK sample code is as follows.
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.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; public class ShowRuleSolution { 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); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>")) .build(); ShowRuleRequest request = new ShowRuleRequest(); request.withDomainId("{domain_id}"); request.withRuleId("{rule_id}"); try { ShowRuleResponse response = client.showRule(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()); } } } |
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 huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.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 = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowRuleRequest() request.domain_id = "{domain_id}" request.rule_id = "{rule_id}" response = client.show_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/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 := codeartspipeline.NewCodeArtsPipelineClient( codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowRuleRequest{} request.DomainId = "{domain_id}" request.RuleId = "{rule_id}" response, err := client.ShowRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
Request succeeded. |
400 |
Request failed. |
401 |
Authentication failed. |
403 |
No permission. |
404 |
Resource not found. |
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