• Workspace

workspace
  1. Help Center
  2. Workspace
  3. API Reference
  4. Desktop Tags
  5. Querying Desktop Tags

Querying Desktop Tags

Function

This interface is used to query tag information of the specified desktop.

URI

  • URI format

    GET /v1.0/{project_id}/workspace/{desktop_id}/tags

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    string

    Specifies the user ID.

    desktop_id

    Yes

    String

    Specifies the desktop ID.

Request

  • Request example
    GET /v1.0/9c53a566cb3443ab910cf0daebca90c4/workspace/8e07d3e9-454e-4fc9-ba56-c631d05c4712/tags

Response

  • Description

    Name

    Type

    Description

    tags

    Dictionary data structure [1]

    Specifies tag information.

[1]tag field data structure description

Name

Type

Description

key

string

Specifies the tag key.

value

string

Specifies the tag value.

Response example
{
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
]
}

Returned Values

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The request syntax is incorrect and cannot be understood by the server.

    401 Unauthorized

    Authentication fails.

    403 Forbidden

    You are not authorized to perform the operation.

    404 Not Found

    The requested resource is not found.

    405 Method Not Allowed

    The method specified in the request is not allowed.

    500 Internal Server Error

    Internal service error. For details about error codes, see Error Code Description.

    503 Service Unavailable

    The service is unavailable.