- What's New
- Service Overview
- Getting Started
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
API
- Instance Management
- Access Control Attribute Management
-
Permission Set Management
- Adding a System-defined Identity Policy
- Deleting a Permission Set
- Querying Permission Set Details
- Updating a Permission Set
- Deleting a System-defined Identity Policy
- Querying Details About a Custom Identity Policy
- Adding a Custom Identity Policy
- Deleting a Custom Identity Policy
- Listing Accounts Associated with a Permission Set
- Listing System-defined Identity Policies
- Listing Pre-provisioning Statuses of Permission Sets
- Listing Permission Sets
- Creating a Permission Set
- Listing Permission Sets Provisioned to an Account
- Pre-provisioning a Permission Set
- Querying Pre-attachment Status Details of a Permission Set
- Adding a System-defined Policy
- Deleting a System-defined Policy
- Listing System-defined Policies
-
Account Assignment Management
- Removing Account Assignments
- Querying Details about the Account Assignment Creation Status
- Listing Account Assignment Creation Statuses
- Listing Account Assignment Deletion Statuses
- Listing Users or Groups Associated with an Account and a Permission Set
- Creating Account Assignments
- Querying Details about the Account Assignment Deletion Status
- Tag Management
- User Management
- Group Management
- Group Membership Management
- SCIM User Management
- SCIM Group Management
- Service Provider (SP) Management
- Client Management
- Token Management
- Device Authorization Management
- Authorization Management
- Account Management
- Agency Management
- Credentials Management
- Appendixes
- Change History
- General Reference
Copied.
Listing Tags for the Specified Resource
Function
This API is used to list the tags that are attached to the specified resource. Currently, tags can only be attached to permission sets.
URI
GET /v1/instances/{resource_type}/{resource_id}/tags
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
resource_type |
Yes |
String |
Resource type Enumerated value:
|
resource_id |
Yes |
String |
Unique ID of a permission set Maximum length: 130 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Maximum number of results returned for each request Minimum value: 1 Maximum value: 100 Default value: 100 |
marker |
No |
String |
Pagination marker Minimum length: 24 Maximum length: 24 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Maximum length: 2048 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
Array of objects |
List of tags |
|
Object |
Pagination information |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key Minimum length: 1 Maximum length: 128 |
value |
String |
Tag value, which can be empty but cannot be null Minimum length: 0 Maximum length: 255 |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the next_marker response element comes back as null. |
current_count |
Integer |
Number of records returned on the current page. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
request_id |
String |
Unique ID of a request |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
request_id |
String |
Unique ID of a request |
Example Request
Listing the tags that are attached to the specified resource
GET https://{hostname}/v1/instances/{resource_type}/{resource_id}/tags
Example Response
Status code: 200
Successful.
{ "tags" : [ { "key" : "auto09230Uv5key", "value" : "auto0923XXFmvalue" } ], "page_info" : { "next_marker" : "5f13d2346712e4890abc5678", "current_count" : 10 } }
Status Code
For details, see Status Codes.
Error Code
For details, 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