Get File Box Tags

Last Updated on : 2026-04-15 02:31:44Copy for LLMView as MarkdownDownload PDF

Retrieve the tag information already set in the file box. This feature aims to simplify the tag management process, helping you find and access the tag configuration in the file box easily.

API address

POST: /v1.0/cloud/agent/file/box/user/tags

Request parameter

Description of body

Parameter name	Type	IN	Required	Description
params	String	body	true	The JSON parameters.
keyName	String	params	false	The tag name.
pageNo	String	params	true	The page number.
pageSize	String	params	true	The number of items returned per page.

Return parameter

Parameter name	Type	Description
result	CloudDriveQueryTagKeyListResp	The returned result.

Description of result

Parameter name	Type	Description
list	List	The list of tags.
totalCount	Long	The total number.

Description of list

Parameter name	Type	Description
tagKey	String	The tag name.
tagKeyDesc	String	The label description.

Request example

POST: /v1.0/cloud/agent/file/box/user/tags

{
  "params": "{\"keyName\":\"Singer\",\"pageNo\":1,\"pageSize\":10}"
}

Return example

{
    "result": {
        "pageSize": 10,
        "list": [
            {
                "tagKeyDesc": "Singer description",
                "tagKey": "Singer"
            }
        ],
        "totalCount": "0",
        "pageNo": 1,
        "requestId": "732fa027364f4d7b8ab4d2b831fb43ff"
    },
    "success": true
}

Error code

For more information, see error code.

Prev DocDocument Library Search

Next DocGet Music Resource List