Querying Objects to Which a Policy Group Is Applied
Function
Queries objects to which a policy group is applied.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v2/{project_id}/policy-groups/{policy_group_id}/targets
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
policy_group_id |
Yes |
String |
Policy group ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
target_type |
No |
String |
Object type. Options:
|
target_name |
No |
String |
Object name. Fuzzy search is supported. |
limit |
No |
Integer |
Number of records on each page. The value ranges from 0 to 1000. |
offset |
No |
String |
Offset. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
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. |
Content-Type |
Yes |
String |
MIME type of the request body, for example, application/json. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
targets |
Array of Target objects |
Objects to which a policy applies. |
total_count |
Integer |
Number of users in the list. |
Parameter |
Type |
Description |
---|---|---|
target_id |
String |
Object ID. |
target_name |
String |
Object name. The value can contain a maximum of 55 characters. |
target_type |
String |
Object type.
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 405
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 503
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason. |
Example Requests
GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/policy-groups/401a23865cae63f3015cceb9affe0049/targets?target_type=INSTANCE&limit=1&offset=1
Example Responses
Status code: 200
Response to the request for querying objects to which a policy is applied.
{ "targets" : [ { "target_id" : "S-1-5-21-1065092785-1316984780-3147557180-9999", "target_type" : "USER", "target_name" : "All-Targets-123" }, { "target_id" : "192.168.1.1", "target_type" : "CLIENTIP", "target_name" : "192.168.1.1" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for querying objects to which a policy is applied. |
400 |
The request cannot be understood by the server due to malformed syntax. |
401 |
Authentication failed. |
403 |
No operation permissions. |
404 |
No resources found. |
405 |
The method specified in the request is not allowed. |
500 |
An internal service error occurred. For details, see the error code description. |
503 |
Service unavailable. |
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