LDAP映射请求

LDAP映射请求

方法 路径 描述
GET /v1/ldap_mappings 获取所有LDAP映射
GET /v1/ldap_mappings/{uid} 获取单个LDAP映射
PUT /v1/ldap_mappings/{uid} 更新一个LDAP映射
POST /v1/ldap_mappings 创建一个新的LDAP映射
DELETE /v1/ldap_mappings/{uid} 删除一个LDAP映射

获取所有LDAP映射

GET /v1/ldap_mappings

获取所有LDAP映射。

所需权限

权限名称
view_all_ldap_mappings_info

请求

示例HTTP请求

GET /ldap_mappings

请求头

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型

响应

返回一个LDAP映射对象的JSON数组。

示例 JSON 主体

[
  {
     "uid": 17,
     "name": "Admins",
     "dn": "OU=ops.group,DC=redislabs,DC=com",
     "email": "ops.group@redislabs.com",
     "role_uids": ["1"],
     "email_alerts": true,
     "bdbs_email_alerts": ["1","2"],
     "cluster_email_alerts": true
  }
]

状态码

代码 描述
200 OK 无错误

获取LDAP映射

GET /v1/ldap_mappings/{int: uid}

获取特定的LDAP映射。

所需权限

权限名称
view_ldap_mapping_info

请求

示例HTTP请求

GET /ldap_mappings/1

请求头

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型

URL 参数

字段 类型 描述
uid integer 对象的唯一ID。

响应

返回一个LDAP映射对象。

示例 JSON 主体

{
     "uid": 17,
     "name": "Admins",
     "dn": "OU=ops.group,DC=redislabs,DC=com",
     "email": "ops.group@redislabs.com",
     "role_uids": ["1"],
     "email_alerts": true,
     "bdbs_email_alerts": ["1","2"],
     "cluster_email_alerts": true
}

错误代码

可能的 error_code 值：

代码 描述
unsupported_resource 集群尚无法处理此资源类型。这可能发生在部分升级的集群中，其中一些节点仍处于先前版本。
ldap_mapping_not_exist 对象不存在

状态码

代码 描述
200 OK 成功。
403 Forbidden 操作被禁止。
404 Not Found ldap_mapping 不存在。
501 Not Implemented 集群尚不支持LDAP映射。

更新LDAP映射

PUT /v1/ldap_mappings/{int: uid}

更新现有的ldap_mapping对象。

所需权限

权限名称
update_ldap_mapping

请求

示例HTTP请求

PUT /ldap_mappings/17

示例 JSON 主体

{
    "dn": "OU=ops,DC=redislabs,DC=com",
    "email": "ops@redislabs.com",
    "email_alerts": true,
    "bdbs_email_alerts": ["1","2"],
    "cluster_email_alerts": true
}

请求头

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型

请求体

在请求体中包含一个LDAP映射对象，并更新字段。

响应

示例 JSON 主体

{
     "uid": 17,
     "name": "Admins",
     "dn": "OU=ops,DC=redislabs,DC=com",
     "email": "ops@redislabs.com",
     "role_uids": ["1"],
     "email_alerts": true,
     "bdbs_email_alerts": ["1","2"],
     "cluster_email_alerts": true
}

错误代码

可能的 error_code 值：

代码 描述
unsupported_resource 集群尚无法处理此资源类型。这可能发生在部分升级的集群中，其中一些节点仍处于先前版本。
name_already_exists 存在相同类型和名称的对象
ldap_mapping_not_exist 对象不存在
invalid_dn_param dn 参数具有非法值
invalid_name_param 名称参数具有非法值
invalid_role_uids_param role_uids 参数具有非法值
invalid_account_id_param account_id 参数具有非法值

状态码

代码 描述
200 OK 成功，LDAP映射已创建。
400 Bad Request 错误或缺少配置参数。
404 Not Found 尝试更改不存在的LDAP映射。
501 Not Implemented 集群尚不支持LDAP映射。

创建LDAP映射

POST /v1/ldap_mappings

创建一个新的LDAP映射。

所需权限

权限名称
create_ldap_mapping

请求

示例HTTP请求

POST /ldap_mappings

示例 JSON 主体

{
     "name": "Admins",
     "dn": "OU=ops.group,DC=redislabs,DC=com",
     "email": "ops.group@redislabs.com",
     "role_uids": ["1"]
}

请求头

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型

请求体

在请求体中包含一个LDAP映射对象。

响应

示例 JSON 主体

{
     "uid": 17,
     "name": "Admins",
     "dn": "OU=ops.group,DC=redislabs,DC=com",
     "email": "ops.group@redislabs.com",
     "role_uids": ["1"]
}

错误代码

可能的 error_code 值：

代码 描述
unsupported_resource 集群尚无法处理此资源类型。这可能发生在部分升级的集群中，其中一些节点仍处于先前版本。
name_already_exists 存在相同类型和名称的对象
missing_field 缺少必要的字段
invalid_dn_param dn 参数具有非法值
invalid_name_param 名称参数具有非法值
invalid_role_uids_param role_uids 参数具有非法值

状态码

代码 描述
200 OK 成功，创建了一个LDAP映射对象。
400 Bad Request 错误或缺少配置参数。
501 Not Implemented 集群尚不支持LDAP映射。

删除LDAP映射

DELETE /v1/ldap_mappings/{int: uid}

删除一个LDAP映射对象。

所需权限

权限名称
delete_ldap_mapping

请求

示例HTTP请求

DELETE /ldap_mappings/1

请求头

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型

URL 参数

字段 类型 描述
uid integer ldap_mapping 的唯一 ID。

响应

返回一个状态码。如果发生错误，响应体可能包含更具体的错误代码和消息。

错误代码

可能的 error_code 值：

代码 描述
unsupported_resource 集群尚无法处理此资源类型。这可能发生在部分升级的集群中，其中一些节点仍处于先前版本。
ldap_mapping_not_exist 对象不存在

状态码

代码 描述
200 OK 成功，ldap_mapping 已被删除。
406 Not Acceptable 请求不可接受。
501 Not Implemented 集群尚不支持LDAP映射。
RATE THIS PAGE
Back to top ↑