云数据库 GaiaDB-X

    白名单管理接口说明

    获取白名单

    接口描述

    本接口用于获取云数据库 GaiaDB-X 实例的IP白名单

    请求结构

    GET /v{version}/instance/{instanceId}/securityIp HTTP/1.1
    HOST: drds.bj.baidubce.com
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URI参数 API版本号
    instanceId String URI参数 实例ID

    响应头域

    参数名称 类型 描述
    ETag string 当前版本号,在修改的时候需要把当前ETag通过header的方式传递回去

    响应参数

    参数名称 类型 描述
    securityIps List<String> 由IP组成的数组

    请求示例

    GET https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/securityIp
    Host: drds.bj.baidubce.com
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
    ETag:v10
    Content-Type: application/json
    {
        "securityIps": [
            "192.168.0.1"
        ]
    }

    修改IP白名单

    接口描述

    本接口用于修改云数据库 GaiaDB-X 实例的IP白名单

    请求结构

    PUT /v{version}/instance/{instanceId}/securityIp HTTP/1.1
    HOST: drds.bj.baidubce.com
    x-bce-if-match: {Etag}
    Authorization: authorization string

    请求头域

    参数名称 类型 描述
    x-bce-if-match string 通过查询接口获取到的ETag值

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URI参数 API版本号
    instanceId String URI参数 实例ID
    securityIps List<String> RequestBody参数 由IP组成的数组,全量的可以访问IP白名单列表,格式须满足CIDR模式

    响应头域

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

    响应参数

    无特殊响应参数

    请求示例

    PUT https://drds.bj.baidubce.com/v1/instance/drds265l1gltivi/securityIp
    Host: drds.bj.baidubce.com
    x-bce-if-match: v10
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
    {
        "securityIps": [
            "192.0.0.1"
        ]
    }

    响应示例

    HTTP/1.1 200 OK
    x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
    Content-Type: application/json
    上一篇
    账号管理接口说明
    下一篇
    其他接口