doc-exports/docs/sfs/api-ref/sfs_02_0077.html
Wei, Hongmin 61f4bfc2ef SFS API initial version
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-18 16:36:56 +00:00

11 KiB

Querying Tag Information About a Shared File System

Function

This API is used to query information of all tags about the specified shared file system.

URI

  • GET /v1/{project_id}/sfs-turbo/{share_id}/tags
  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    string

    Specifies the project ID of the operator.

    share_id

    Yes

    string

    Specifies the ID of the shared file system.

Request

  • Parameter description

    None

  • Example request

    None

Response

  • Parameter description

    Parameter

    Type

    Description

    tags

    List<resource_tag>

    Specifies the tag list. For details, see Description of field resource_tag.

    sys_tags

    List<resource_tag>

    Only the op_service permission can obtain this field.

    1. Currently, only one resource_tag structure key is used, _sys_enterprise_project_id.
    2. Currently, key contains only one value. 0 indicates the default enterprise project.

    This field cannot be returned in non-op_service scenarios.

    For details, see Description of field resource_tag.

  • Description of field resource_tag

    Parameter

    Type

    Description

    key

    string

    Specifies the key of the tag.

    value

    string

    Specifies the value of the tag.

  • Example response
    { 
            "tags": [ 
             { 
                 "key": "key1", 
                 "value": "value1" 
             }, 
             { 
                 "key": "key2", 
                 "value": "" 
             } 
         ] 
     }

Status Codes

  • Normal

    200

  • Abnormal

    Status Code

    Description

    400 Bad Request

    Invalid value.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    Access to the requested page is forbidden.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Failed to complete the request, because of a service error.