- API Reference
- SFS Turbo APIs
- Tag Management
- Querying Tags of a File System
Querying Tags of a File System¶
Function¶
This API is used to query all tags of a specified file system.
URI¶
GET /v1/{project_id}/sfs-turbo/{share_id}/tags
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID |
share_id | Yes | String | File system ID |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | Account token |
Content-Type | Yes | String | MIME type |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
tags | Array of ResourceTag objects | Tag list |
sys_tags | Array of ResourceTag objects | Only users with the op_service permission can obtain this field.
This field is not returned for users without the op_service permission. |
Parameter | Type | Description |
---|---|---|
key | String | Tag key. It can contain a maximum of 128 characters. It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks ( Minimum: 1 Maximum: 128 |
value | String | Tag value. Each tag value can contain a maximum of 255 characters and can be an empty string. It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks ( Minimum: 0 Maximum: 255 |
Example Requests¶
Querying tags of the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde
GET HTTPS://{endpoint}/v1/v1/{project_id}/sfs-turbo/77ba6f4b-6365-4895-8dda-bc7142af4dde/tags
Example Responses¶
Status code: 200
Response body for query all tags of a specified file system
{
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value1"
} ]
}
Status Codes¶
Status Code | Description |
---|---|
200 | Response body for query all tags of a specified file system |
Error Codes¶
See Error Codes.