云数据库 SCS for Redis

    获取实例列表

    描述

    • 只能查看属于自己账号的实例列表。

    请求结构

    GET /v{version}/instance?marker={marker}&maxKeys={maxKeys} HTTP/1.1
    Host: redis.{region}.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必须 参数位置 描述
    version string URL参数 API版本号
    marker string Query参数/td> 批量获取列表的查询的起始位置,是一个由系统生成的字符串
    maxKeys int Query参数 每页包含的最大数量(主实例),最大数量通常不超过1000,缺省值为1000。

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    marker String 批量获取列表的查询的起始位置,是一个由系统生成的字符串
    maxKeys int 每页包含的最大数量,最大数量通常不超过1000,缺省值为1000。
    isTruncated boolean true表示后面还有数据,false表示已经是最后一页
    nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    instances List<InstanceModel> InstanceModel组成的数组

    请求示例

    GET /v2/instance?marker=-1&maxKeys=20 HTTP/1.1
    HOST: redis.bj.baidubce.com
    ContentType: application/json   
    Authorization: bce-auth-v1/0255cb4f78f140728045b551d6a317ec/2018-11-13T05:57:04Z/1800/host/633fd6aadc177fce91e5e930c63886b5fb4da8938d9a02c9d13df4fdb8efdec5

    返回示例

    {
        "marker": "-1",
        "isTruncated": true,
        "nextMarker": "1058",
        "maxKeys": 1,
        "instances": [
            {
                "instanceId": "scs-bj-cxisuftlkquj",
                "instanceName": "post101",
                "instanceStatus": "Running",
                "engine": "redis",
                "engineVersion": "3.2",
                "vnetIp": "10.107.231.11",
                "domain": "redis.ruqpwjmvrsyt.scs.bj.bce.qa.sandbox.baidu.com",
                "port": "6379",
                "instanceCreateTime": "2018-11-13T05:37:49Z",
                "capacity": 1,
                "usedCapacity": 0.06,
                "paymentTiming": "Postpaid",
                "zoneNames": [
                    "cn-bj-a",
                    "cn-bj-c"
                ]
            }
        ]
    }
    上一篇
    订单服务
    下一篇
    获取实例详情