Obtaining Policy Details
Function
This API is used to obtain policy details.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{domain_id}/tenant/rule-sets/{rule_set_id}/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
rule_set_id |
Yes |
String |
Definition: Policy ID. Constraints: N/A Value range: N/A Default value: N/A |
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cloud_project_id |
No |
String |
Definition: Project ID. For details, see Obtaining a Project 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 template instance ID. Value range: The value consists of 32 characters, including digits and letters. |
name |
String |
Definition: Rule template instance name. Value range: N/A |
type |
String |
Definition: Rule template type. Value range: N/A |
version |
String |
Definition: Rule template policy. Value range: N/A |
creator |
String |
Definition: Policy creator. Value range: N/A |
create_time |
String |
Definition: Policy creation time. Value range: N/A |
updater |
String |
Definition: User who last updated the policy. Value range: N/A |
update_time |
String |
Definition: Time when the policy was last updated. Value range: N/A |
is_valid |
Boolean |
Definition: Whether the policy takes effect. Value range:
|
rule_instances |
Array of RuleInstance objects |
Definition: Rule instance set. Value range: N/A |
level |
String |
Definition: Effective level of a rule instance. Value range: N/A |
is_public |
Boolean |
Definition: Whether the rule instance is system-level. Value range:
|
is_legacy |
Boolean |
Definition: Whether the rule instance data is from version 1.0. Value range:
|
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Rule instance ID. Value range: The value consists of 32 characters, including digits and letters. |
type |
String |
Definition: Rule type. Value range: N/A |
name |
String |
Definition: Rule name. Value range: N/A |
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 |
is_valid |
Boolean |
Definition: Whether the rule takes effect. Value range:
|
editable |
Boolean |
Definition: Whether the rule can be edited. Value range:
|
content |
Array of RuleInstanceContent objects |
Definition: Rule instance set. Value range: N/A |
parent |
RuleSet object |
Definition: Parent instance attribute. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
group_name |
String |
Definition: Group name. Value range: N/A |
editable |
Boolean |
Definition: Editable or not. Value range: N/A |
type |
String |
Definition: Group type. Value range: N/A |
can_modify_when_inherit |
Boolean |
Definition: Whether the threshold of the inherited sub-policy can be modified. Value range:
|
properties |
Array of RuleInstanceProperty objects |
Definition: Rule attributes. Constraints: N/A Value range: N/A Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition: Rule attribute key. Value range: N/A |
type |
String |
Definition: Rule type. Value range: N/A |
name |
String |
Definition: Displayed name. Value range: N/A |
operator |
String |
Definition: Comparison operator. Value range: N/A |
value |
String |
Definition: Attribute value. Value range: N/A |
value_type |
String |
Definition: Data type. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Rule template instance ID. Value range: N/A |
name |
String |
Definition: Rule template instance name. Value range: N/A |
type |
String |
Definition: Rule instance type. Value range: N/A |
version |
String |
Definition: Rule instance version. Value range: N/A |
operator |
String |
Definition: Latest operator of the rule instance. Value range: N/A |
operate_time |
Long |
Definition: Time when the rule was last operated. Value range: N/A |
is_valid |
Boolean |
Definition: Whether the rule instance takes effect. Value range:
|
level |
String |
Definition: Effective level of a rule instance. Value range: N/A |
is_public |
Boolean |
Definition: Whether the rule instance is system-level. Value range:
|
is_legacy |
Boolean |
Definition: Whether the rule instance data is from version 1.0. Value range:
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: N/A |
Example Requests
GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/detail?cloud_project_id=
Example Responses
None
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 ShowStrategySolution { 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(); ShowStrategyRequest request = new ShowStrategyRequest(); request.withRuleSetId("{rule_set_id}"); request.withDomainId("{domain_id}"); try { ShowStrategyResponse response = client.showStrategy(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 = ShowStrategyRequest() request.rule_set_id = "{rule_set_id}" request.domain_id = "{domain_id}" response = client.show_strategy(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.ShowStrategyRequest{} request.RuleSetId = "{rule_set_id}" request.DomainId = "{domain_id}" response, err := client.ShowStrategy(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 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
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