文档数据库服务 DDS-查询资源实例:响应消息

时间:2023-11-08 16:33:03

响应消息

  • 参数说明
    表5 参数说明

    名称

    参数类型

    描述

    instances

    Array of objects

    实例列表。详情请参见表6

    total_count

    Integer

    总记录数。

    表6 instance字段数据结构说明

    名称

    参数类型

    描述

    instance_id

    String

    实例ID,可以调用“查询实例列表”接口获取。如果未申请实例,可以调用“创建实例”接口创建。

    instance_name

    String

    实例名称。

    tags

    Array of objects

    标签列表。如果没有标签,默认为空数组。详情请参见表7

    表7 tags字段数据结构说明

    名称

    参数类型

    描述

    key

    String

    标签键。

    • key不能为空,长度1~128个半角字符。
    • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @。
    • _sys_开头属于系统标签,租户不能输入。

    字符集:0-9,A-Z,a-z,“_”,“-”,中文。

    value

    String

    标签值。

    • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @。
    • 可以为空(empty or null),长度0~255个半角字符。

    字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。

  • 响应示例

    根据标签返回指定实例:

    {
      "instances": [
        {
          "instance_id": "2acbf2223caf3bac3c33c6153423c3ccin02",
          "instance_name": "test-single",
          "tags": [
            {
              "key": "key1",
              "value": "value1"
            },
            {
              "key": "key2",
              "value": "value1"
            }
          ]
        }
      ]
    }

    返回总记录数:

    {
      "total_count": 4
    }
support.huaweicloud.com/api-dds/dds_api_0032.html