doc-exports/docs/sdrs/api-ref/sdrs_05_0805.html
Wei, Hongmin ab56d080fb SDRS 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-26 13:51:50 +00:00

13 KiB

Querying a Protected Instance Tag

Function

This API is used to query tags of a specified protected instance.

URI

  • URI format

    GET /v1/{project_id}/protected-instances/{protected_instance_id}/tags

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Specifies the project ID.

    protected_instance_id

    Yes

    String

    Specifies the ID of a protected instance.

    For details, see Querying Protected Instances.

Response

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    tags

    Yes

    Array of objects

    Specifies the tag list.

    For details, see Table 1.

    Table 1 resource_tag field description

    Parameter

    Mandatory

    Type

    Description

    key

    Yes

    String

    Specifies the tag key. The tag key of a resource must be unique.

    value

    Yes

    String

    Specifies the tag value.

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

Returned Value

  • Normal

    Returned Value

    Description

    200

    OK

  • Abnormal

    Returned Value

    Description

    400

    Invalid parameters.

    401

    Authentication failed.

    403

    Insufficient permission.

    404

    The requested resource was not found.

    500

    Internal service error.