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 |
Policy ID. |
domain_id |
Yes |
String |
Tenant ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cloud_project_id |
No |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule template instance ID. |
name |
String |
Rule template instance name. |
type |
String |
Type. |
version |
String |
Version. |
creator |
String |
Creator. |
create_time |
String |
Creation time. |
updater |
String |
Last updater. |
update_time |
String |
Last update time. |
is_valid |
Boolean |
Whether it is effective. |
rule_instances |
Array of RuleInstance objects |
Rule instance set. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule instance ID. |
type |
String |
Rule type ID. |
name |
String |
Rule name. |
version |
String |
Rule version. |
plugin_id |
String |
Extension ID. |
plugin_name |
String |
Extension name. |
plugin_version |
String |
Extension version. |
is_valid |
Boolean |
Whether it is effective. |
editable |
Boolean |
Editable or not. |
content |
Array of RuleInstanceContent objects |
Rule attribute list. |
parent |
RuleSet object |
Basic information of parent rule template. |
Parameter |
Type |
Description |
---|---|---|
group_name |
String |
Group name. |
type |
String |
Group type. |
can_modify_when_inherit |
Boolean |
Whether thresholds of an inherited policy can be modified. |
properties |
Array of RuleInstanceProperty objects |
Rule attribute list. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Attribute key. |
type |
String |
Type. |
name |
String |
Display name. |
operator |
String |
Comparison operators. |
value |
String |
Attribute value. |
value_type |
String |
Data type. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule template instance ID. |
name |
String |
Rule template instance name. |
type |
String |
Type. |
version |
String |
Version. |
operator |
String |
Latest operator. |
operate_time |
Long |
Latest operation time. |
is_valid |
Boolean |
Whether it is effective. |
level |
String |
Tenant-level, project-level |
is_public |
Boolean |
System level or not. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
Example Requests
GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/detail?cloud_project_id=
Example Responses
Status code: 200
OK
{ "id" : "6cb18ee5ca1c48caa335706e0e5ee288", "name" : "Create a tenant-level policy.", "version" : "c0ca09cfda8a426bbdb8df4c34c4831e", "is_valid" : true, "creator" : "847a5317086c41798469d0868535943a", "create_time" : "2023-09-25T19:32:14", "updater" : "847a5317086c41798469d0868535943a", "update_time" : "2023-10-20T17:12:41", "rule_instances" : [ { "id" : "80cfcff078074b8aa7951d7b67b3137b", "type" : "Gate", "name" : "API automatic creation rule dyEnd", "is_valid" : true, "version" : "8128ca663cdc4cea9a6dc05e53ae0a55", "plugin_id" : "official_devcloud_apiTest", "plugin_name" : "official_devcloud_apiTest", "plugin_version" : "0.0.6", "content" : [ { "group_name" : "API test pass rate access control", "can_modify_when_inherit" : false, "properties" : [ { "key" : "apitest", "type" : "judge", "name" : "API test pass rate", "value_type" : "float", "value" : "0.5", "operator" : ">=" } ] } ] } ] }
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 |
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.withCloudProjectId("<cloud_project_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 |
# 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.cloud_project_id = "<cloud_project_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{} cloudProjectIdRequest:= "<cloud_project_id>" request.CloudProjectId = &cloudProjectIdRequest 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