接口说明
更新时间：2022-06-22
Topic相关接口
创建Topic
描述
本接口用于创建一个Kafka topic。
请求
-
请求结构
Plain Text1POST /v{version}/topic?clientToken={clientToken} HTTP/1.1 2{ 3 "topicName": "topicName", 4 "partitionCount": partitionCount, 5} -
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 clientToken String 是 Query参数 幂等性Token，是一个长度不超过64位的ASCII字符串，详见链接 topicCreateParameters TopicCreateParameters 是 RequestBody参数 创建topic参数
返回
-
返回头域
除公共头域，无其它特殊头域。
-
返回参数
参数名称 类型 描述 topicName String topic名称
错误码
| 错误码 | HTTP状态码 | 中文解释 |
|---|---|---|
| TopicAlreadyExist | 409 | topic名已经存在 |
| TopicLimitExceeded | 402 | topic总数超过限制，最多只能创建20个 |
| TopicPartitionLimitExceeded | 402 | 单个topic分区总数超过限制，每个topic最多只能创建10个分区 |
| InvalidTopicName | 400 | topic名不合法，只能包含大小写英文字母，数字，下划线_，横行-，不能使用双下划线__ |
| InvalidTopicPartitionCount | 400 | 分区数需要大于0 |
示例
-
请求示例
Plain Text1POST /v1/topic?clientToken=16011728-8000-4ef4-9299-020db1424806 HTTP/1.1 2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd 3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580 4host: kafka-api.bj.baidubce.com 5x-bce-date: 2017-02-16T02:17:25Z 6content-type: application/json 7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3) 8content-length: 53 9connection: Keep-Alive 10accept-encoding: gzip,deflate 11{ 12 "topicName" : "demo", 13 "partitionCount" : 1 14} -
返回示例
Plain Text1HTTP/1.1 200 OK 2Transfer-Encoding: chunked 3Cache-Control: no-cache 4Server: BWS 5Date: Thu, 16 Feb 2017 02:17:26 GMT 6Content-Type: application/json;charset=UTF-8 7 8{"topicName":"demo"}
查询topic列表
描述
查询所有topic的详细信息。
请求
-
请求结构
Plain Text1GET /v{version}/topic?marker={marker}&maxKeys={maxKeys} HTTP/1.1 -
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 marker String 否 Query参数 批量获取列表的查询的起始位置，是一个由系统生成的字符串 maxKeys int 否 Query参数 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000
返回
-
返回头域
除公共头域，无其它特殊头域。
-
返回参数
参数名称 类型 描述 marker String 标记查询的起始位置 isTruncated boolean true表示后面还有数据，false表示已经是最后一页 nextMarker String 获取下一页所需要传递的marker值，当isTruncated为false时，该域不出现 topics List<Topic> topic信息，由 Topic 组成的集合
错误码
| 错误码 | HTTP状态码 | 中文解释 |
|---|---|---|
| InvalidMarker | 400 | marker不能为空，且长度应小于topic名最大长度 |
示例
-
请求示例
Plain Text1GET /v1/topic?marker=demo&maxKeys=10 HTTP/1.1 2authorization: bce-auth-v1/e9af9439-0c14-4b98-abae-ba14f11b25ec/2017-02-15T08:08:08Z/3600/host;x-bce-console-rpc-id;x-bce-date/69143dbee3abf6b6143c8266139645a19c192de6d25082fed3611ad2fe28b456/ 3x-bce-console-rpc-id: d4d32d1f-f2cd-41a8-bfb7-fdd65cdc6ed9 4host: kafka-api.bj.baidubce.com 5x-bce-date: 2017-02-15T08:08:08Z 6user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3) 7connection: Keep-Alive 8accept-encoding: gzip,deflate -
返回示例
Plain Text1HTTP/1.1 200 OK 2Transfer-Encoding: chunked 3Cache-Control: no-cache 4Server: BWS 5Date: Wed, 15 Feb 2017 08:08:09 GMT 6Content-Type: application/json;charset=UTF-8 7 8{ 9 "marker": "demo", 10 "nextMarker": "test", 11 "topics": [{ 12 "topicName": "demo", 13 "partitionCount": 3, 14 "replicationFactor": 3, 15 "createTime": "2017-02-15T08:08:09Z" 16 }], 17 "isTruncated": false 18}
查询topic详情
描述
查询单个topic的详细信息。
请求
-
请求结构
Plain Text1GET /v{version}/topic/{topicName} HTTP/1.1 -
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 topicName String 是 URL参数 topic名
返回
-
返回头域
除公共头域，无其它特殊头域。
-
返回参数
参数名称 类型 描述 topic Topic 返回的topic详情
错误码
| 错误码 | HTTP状态码 | 中文解释 |
|---|---|---|
| TopicNotFound | 404 | topic不存在 |
示例
-
请求示例
Plain Text1GET /v1/topic/demo HTTP/1.1 2authorization: bce-auth-v1/e9af9439-0c14-4b98-abae-ba14f11b25ec/2017-02-15T08:19:54Z/3600/host;x-bce-console-rpc-id;x-bce-date/6301919cc9ade759c88bfc47a7eee26b8347179f1c2fcd2808acfa4ab6d8b800 3x-bce-console-rpc-id: 89ca2463-4d0d-453d-9b7c-4e4cf52214e7 4host: kafka-api.bj.baidubce.com 5x-bce-date: 2017-02-15T08:19:54Z 6user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3) 7connection: Keep-Alive 8accept-encoding: gzip,deflate -
返回示例
Plain Text1HTTP/1.1 200 OK 2Transfer-Encoding: chunked 3Cache-Control: no-cache 4Server: BWS 5Date: Wed, 15 Feb 2017 08:19:55 GMT 6Content-Type: application/json;charset=UTF-8 7 8{ 9 "topic": { 10 "name": "demo", 11 "partitionCount": 3, 12 "replicationFactor": 3, 13 "createdAt": "2017-02-15T08:19:55Z" 14 } 15}
删除topic
描述
删除一个指定的topic。
请求
-
请求结构
Plain Text1DELETE /v{version}/topic/{topicName} HTTP/1.1 -
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 topicName String 是 URL参数 待删除topic名
返回
-
返回头域
除公共头域，无其它特殊头域
-
返回参数
无特殊返回参数
错误码
| 错误码 | HTTP状态码 | 中文解释 |
|---|---|---|
| TopicNotFound | 404 | topic不存在 |
示例
-
请求示例
Plain Text1DELETE /v1/topic/demo HTTP/1.1 2authorization: bce-auth-v1/e9af9439-0c14-4b98-abae-ba14f11b25ec/2017-02-15T08:34:26Z/3600/host;x-bce-console-rpc-id;x-bce-date/fbfec8e0ab86dfdbd2bce5d353f7cdd0bec78303a86f1ca1d939a85dae2284d6 3x-bce-console-rpc-id: 5bdd1701-cbb6-48cc-9819-a457a0475539 4host: kafka-api.bj.baidubce.com 5x-bce-date: 2017-02-15T08:34:26Z 6user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3) 7connection: Keep-Alive 8accept-encoding: gzip,deflate -
返回示例
Plain Text1HTTP/1.1 200 OK 2Cache-Control: no-cache
权限管理相关接口
添加授权
描述
本接口用于给用户对某个kafka topic授权
请求
- 请求结构
Plain Text
1POST /v{version}/authorization/add HTTP/1
2{
3 "topic": "topic",
4 "accountId": "accountId",
5 "certificateSN": "certificateSN",
6 "certificateId": "certificateId",
7 "topicOperation": "ReadWrite"
8}-
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 TopicAuthorizationParameters TopicAuthorizationParameters 是 RequestBody参数 添加授权参数
返回
-
返回头域
除公共头域，无其它特殊头域。
-
返回参数
无特殊返回参数
错误码
| 错误码 | HTTP状态码 | 中文解释 |
|---|---|---|
| InvalidRequestException | 400 | 请求体中某些参数为空 |
示例
-
请求示例
Plain Text1POST /v1/authorization/add 2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd 3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580 4host: kafka-api.bj.baidubce.com 5x-bce-date: 2017-02-16T02:17:25Z 6content-type: application/json 7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3) 8content-length: 53 9connection: Keep-Alive 10accept-encoding: gzip,deflate 11 12{ 13 "topic": "demo", 14 "accountId": "accountId", 15 "certificateSN": "certificateSN", 16 "certificateId": "certificateId", 17 "topicOperation": "ReadWrite" 18} -
返回示例
Plain Text1HTTP/1.1 200 OK 2Transfer-Encoding: chunked 3Cache-Control: no-cache 4Server: BWS 5Date: Thu, 16 Feb 2017 02:17:26 GMT 6Content-Type: application/json;charset=UTF-8
取消授权
描述
本接口用于针对自己的某个topic，取消对某个用户的授权
请求
- 请求结构
Plain Text
1POST /v{version}/authorization/cancel HTTP/1.1
2
3{
4 "topic": "topic",
5 "accountId": "accountId",
6 "certificateSN": "certificateSN",
7}-
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 topic String 是 RequestBody参数 topic名称，只能包含大小写英文字母，数字，下划线 _，横行-，不能使用双下划线__accountId String 是 RequestBody参数 用户Id certificateSN String 是 RequestBody参数 证书序列号
返回
-
返回头域
除公共头域，无其它特殊头域。
-
返回参数
无特殊返回参数
错误码
| 错误码 | HTTP状态码 | 中文解释 |
|---|---|---|
| InvalidRequestException | 400 | topic参数为空 |
示例
-
请求示例
Plain Text1POST /v1/authorization/cancel 2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd 3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580 4host: kafka-api.bj.baidubce.com 5x-bce-date: 2017-02-16T02:17:25Z 6content-type: application/json 7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3) 8content-length: 53 9connection: Keep-Alive 10accept-encoding: gzip,deflate 11 12{ 13 "topic": "demo", 14 "accountId": "accountId", 15 "certificateSN": "certificateSN", 16} -
返回示例
Plain Text1HTTP/1.1 200 OK 2Transfer-Encoding: chunked 3Cache-Control: no-cache 4Server: BWS 5Date: Thu, 16 Feb 2017 02:17:26 GMT 6Content-Type: application/json;charset=UTF-8
查询授权信息列表
描述
本接口用于按照不同的查询条件获取授权的topic列表
请求
-
请求结构
Plain Text1POST /v{version}/authorization/list HTTP/1.1 2 3{ 4 "topicLike": "topicLike", 5 "accountId": "accountId", 6 "certificateSN": "certificateSN", 7 "begin": 8 "limit": 9} -
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 topicLike String 是 RequestBody参数 topic名称，只支持模糊搜索 accountId String 是 RequestBody参数 用户Id certificateSN String 是 RequestBody参数 证书序列号 limit Integer 否 RequestBody参数 查询记录数 begin Integer 否 RequestBody参数 查询起始索引
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| begin | int | 查询起始索引 |
| size | int | 查询记录数 |
| topicAuthList | List<TopicAuthorizationParameters > | 由TopicAuthorization组成的集合 |
错误码
无
示例
-
请求示例
Plain Text1POST /v1/authorization/list 2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd 3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580 4host: kafka-api.bj.baidubce.com 5x-bce-date: 2017-02-16T02:17:25Z 6content-type: application/json 7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3) 8content-length: 53 9connection: Keep-Alive 10accept-encoding: gzip,deflate 11 12{ 13 "topic": "demo", 14 "accountId": "accountId", 15 "certificateSN": "certificateSN", 16 "begin": 0, 17 "limit": 10 18} -
返回示例
Plain Text1HTTP/1.1 200 OK 2Transfer-Encoding: chunked 3Cache-Control: no-cache 4Server: BWS 5Date: Thu, 16 Feb 2017 02:17:26 GMT 6Content-Type: application/json;charset=UTF-8 7 8{ 9 "begin":1, 10 "size":5, 11 "topicAuthList":[] 12}
group对证书授权
描述
本接口用于group对证书授权
请求
-
请求结构
Plain Text1POST /v{version}/authorization/consumergroup/add HTTP/1.1 2 3{ 4 "consumerGroupName": "consumerGroupName", 5 "accountId": "accountId", 6 "certificateId": "certificateId" 7} -
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 GroupAuthorizationParameters GroupAuthorizationParameters 是 RequestBody参数 group授权参数
返回
-
返回头域
除公共头域，无其它特殊头域。
-
返回参数
无特殊返回参数
错误码
无
示例
-
请求示例
Plain Text1POST /v1/authorization/consumergroup/add 2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd 3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580 4host: kafka-api.bj.baidubce.com 5x-bce-date: 2017-02-16T02:17:25Z 6content-type: application/json 7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3) 8content-length: 53 9connection: Keep-Alive 10accept-encoding: gzip,deflate 11 12{ 13 "topic": "demo", 14 "accountId": "accountId", 15 "certificateSN": "certificateSN", 16} - 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8取消group对证书授权
描述
本接口用于group对证书授权
请求
- 请求结构
Plain Text
1POST /v{version}/authorization/consumergroup/remove HTTP/1.1
2
3{
4 "consumerGroupName": "consumerGroupName",
5 "accountId": "accountId",
6 "certificateId": "certificateId"
7}-
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 GroupAuthorizationParameters GroupAuthorizationParameters 是 RequestBody参数 取消group授权参数
返回
-
返回头域
除公共头域，无其它特殊头域。
-
返回参数
无特殊返回参数
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/authorization/consumergroup/add
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate
11
12{
13 "topic": "demo",
14 "accountId": "accountId",
15 "certificateSN": "certificateSN",
16}- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8查询group对证书授权
描述
本接口用于按照consumer group查询被授权的证书
请求
- 请求结构
POST /v{version}/authorization/consumergroup/list?accountId={accountId}&certType={certType}&group={consumerGroupName} HTTP/1.1
-
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 accountId String 否 Query参数 用户Id certType String 否 Query参数 证书类型 group String 否 Query参数 consumer group名称
返回
-
返回头域
除公共头域，无其它特殊头域。
-
返回参数
无特殊返回参数
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/authorization/consumergroup/list?accountId=account1&certType=privilege&group=consumerGroupName1
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8{
9 "authorizedCertificates":[
10 "certificateId": "certificateDemo",
11 "description": "descriptionDemo",
12 "consumerGroupOperation": "Use"
13 ]
14}证书管理相关接口
查询证书列表
描述
本接口用于查询证书列表
请求
- 请求结构
GET /v{version}/certificate/list?marker={marker}&maxKeys={maxKeys} HTTP/1.1
- 请求头域 除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 version String 是 URL参数 API版本号 marker String 否 Query参数 查询位置标记，批量获取列表的查询的起始位置，是一个由系统生成的字符串 maxKeys Integer 否 Query参数 查询最大记录数,每页包含的最大数量，最大数量通常不超过1000，缺省值为1000
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值，当isTruncated为false时，该域不出现 |
| certificates | List |
certificates信息，由 certificate组成的集合 |
错误码
无
示例
- 请求示例
Plain Text
1GET /v1/authorization/certificate/list?marker=marker&maxKeys=10
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8 {
9 "marker": "demo",
10 "nextMarker": "test",
11 "isTruncated": false,
12 "certificates":[],
13 }获取certificate信息
描述
本接口用于获取certificate信息
请求
- 请求结构
POST /v{version}/certificate/detail/{certificateId} HTTP/1.1
- 请求头域 除公共头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| certificateId | String | 是 | URL参数 | 证书Id |
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| certificate | certificate | certificates信息 |
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/authorization/certificate/detail/certificateId1
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8{
9 "certificate":{
10 "uuid": ,
11 "accountId": ,
12 "certificateCN": ,
13 "createAt": ,
14 "revokeAt": ,
15 "certificate": ,
16 "privateKey": ,
17 "region": ,
18 "description": ,
19 "isPrivilege":}
20 }重新生成新的证书
描述
本接口用于重新生成新的证书
请求
- 请求结构
Plain Text
1 POST /v{version}/certificate/recreate HTTP/1.1
2 {
3 "certificateSN":"certificateSN"
4 }- 请求头域 除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 是否必需 参数位置 描述 certificateSN String 是 RequestBody 证书Id
返回
-
返回头域
除公共头域，无其它特殊头域。
-
返回参数
参数名称 类型 描述 certificate certificate certificates信息
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/authorization/certificate/recreate
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8{
9 "certificate":{
10 "uuid": ,
11 "accountId": ,
12 "certificateCN": ,
13 "createAt": ,
14 "revokeAt": ,
15 "certificate": ,
16 "privateKey": ,
17 "region": ,
18 "description": ,
19 "isPrivilege":}
20}创建普通证书
描述
本接口用于查询证书列表
请求
- 请求结构
Plain Text
1POST /v{version}/certificate/create/ordinary HTTP/1.1
2
3{
4 "description":"",
5 "authInfos":[]
6}
7 - 请求头域 除公共头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| description | String | 是 | RequestBody参数 | 证书描述 |
| authInfos | List<authInfo> | authInfos信息，由authInfo组成的集合 |
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| certificate | certificate | certificates信息 |
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/certificate/create/ordinary
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate
11
12 {
13 "description":"",
14 "authInfos":[
15 {
16 "topic": "demo",
17 "topicCluster": "KAFKA_01",
18 "topicOperation":"Read"
19 }
20 ]
21 }- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8 {
9 "status":0,
10 "msg":"success",
11 "data":{
12 "uuid": ,
13 "accountId": ,
14 "certificateCN": ,
15 "createAt": ,
16 "revokeAt": ,
17 "certificate": ,
18 "privateKey": ,
19 "region": ,
20 "description": ,
21 "isPrivilege":}
22 }创建特权证书
描述
本接口用于创建特权证书
请求
- 请求结构
Plain Text
1POST /v{version}/certificate/create/privilege HTTP/1.1
2
3 {
4 "description":"description",
5 "topicOperation":"Read"
6 }
7 - 请求头域 除公共头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| description | String | 否 | RequestBody参数 | 证书描述 |
| topicOperation | String | 否 | RequestBody参数 | 授权，如果不指定，则没有权限 |
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| certificate | certificate | certificates信息 |
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/certificate/create/privilege
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate
11
12 {
13 "description":"description",
14 "topicOperation":"Read"
15 }
16 - 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8 {
9 "status":0,
10 "msg":"success",
11 "data":{
12 "uuid": ,
13 "accountId": ,
14 "certificateCN": ,
15 "createAt": ,
16 "revokeAt": ,
17 "certificate": ,
18 "privateKey": ,
19 "region": ,
20 "description": ,
21 "isPrivilege":}
22 }
23 删除证书
描述
本接口用于删除证书
请求
- 请求结构
Plain Text
1POST /v{version}/certificate/delete HTTP/1.1
2 {
3 "uuid":"uuidDemo"
4 }
5 - 请求头域 除公共头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| uuid | String | 是 | RequestBody | 证书序列号 |
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
无特殊返回参数
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/certificate/delete
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate
11
12 {
13 "uuid": "uuidDemo"
14 }
15 - 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7{
8 "status":0,
9 "msg":"success",
10 "data":true
11 } 更改证书备注
描述
本接口用于更改证书备注
请求
- 请求结构
Plain Text
1POST /v{version}/certificate/update HTTP/1.1
2 {
3 "uuid": "uuidDemo"
4 "description": "descriptionDemo"
5 }-
请求头域
除公共头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| uuid | String | 是 | RequestBody | 证书序列号 |
| description | String | 是 | RequestBody | 证书描述 |
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| certificate | certificate | certificates信息 |
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/certificate/update
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate
11
12 {
13 "uuid": "uuidDemo"
14 "description": "descriptionDemo"
15 }- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8 {
9 "status":0,
10 "msg":"success",
11 "data":{
12 "uuid": ,
13 "accountId": ,
14 "certificateCN": ,
15 "createAt": ,
16 "revokeAt": ,
17 "certificate": ,
18 "privateKey": ,
19 "region": ,
20 "description": ,
21 "isPrivilege":}
22 }下载证书
描述
本接口用于下载证书
请求
- 请求结构
Plain Text
1POST /v{version}/certificate/download HTTP/1.1
2 {
3 "certificateSN": ""
4 }-
请求头域
除公共头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| certificateSN | String | 是 | RequestBody | 证书Id |
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
返回证书文件
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/certificate/download
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate
11
12 {
13 "certificateSN": "certificateDemo"
14 }
15 - 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/octet-stream
7 下载sample样例文件
描述
本接口用于下载sample样例文件
请求
- 请求结构
POST /v{version}/certificate/download/sample HTTP/1.1
- 请求头域
除公共头域外，无其它特殊头域。 - 请求参数
无
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
返回sample样例文件
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/authorization/certificate/download/sample
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/octet-stream
7 集群管理接口
获取用户创建集群的权限列表
描述
本接口用于获取用户创建集群的权限列表
请求
- 请求结构
POST /v{version}/cluster/permission HTTP/1.1
- 请求头域
除公共头域外，无其它特殊头域。 - 请求参数
无
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| clusterPermissions | List |
clusterPermissions信息，由clusterPermission组成的集合 |
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/cluster/permission
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8{
9 "clusterPermissions":[{
10 "accountId": "accountId",
11 "cluster": "KAFKA_02",
12 "isVisible":false},
13 ]
14}Consumer Group管理相关接口
创建ConsumerGroup
描述
本接口用于创建ConsumerGroup
请求
- 请求结构
POST /v{version}/consumergroups/new/create HTTP/1.1 { "consumerGroupName":"consumerGroupName" }
- 请求头域
除公共头域外，无其它特殊头域。 - 请求参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| consumerGroupName | String | consumerGroup名称 |
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| consumerGroupName | String | consumerGroup名称 |
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/consumergroups/new/create
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate
11
12 {
13 "consumerGroupName":"consumerGroupDemo"
14 }- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8 {
9 "consumerGroupName":"consumerGroupDemo"
10 }ConsumerGroup列表
描述
本接口用于获取ConsumerGroup列表
请求
- 请求结构
POST /v{version}/consumergroups/new/list?begin={begin}&limit={limit} HTTP/1.1
- 请求头域
除公共头域外，无其它特殊头域。 - 请求参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| begin | url | 检索记录开始索引 |
| limit | url | 要检索的记录数 |
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| begin | Integer | 检索记录开始索引 |
| limit | Integer | 要检索的记录数 |
| consumerGroups | List |
consumerGroups信息，由consumerGroup组成的集合 |
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/consumergroups/new/list?begin=0&limit=1
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8 {
9 "consumerGroups":
10 {
11 "size":
12 "begin":
13 "consumerGroups":[]
14 }
15 ]
16 }获取Topic的groupId列表
描述
本接口用于获取Topic的groupId列表
请求
-
请求结构
Plain Text1 POST /v{version}/consumergroups/list HTTP/1.1 2 3 { 4 "begin":1, 5 "limit":10, 6 "topicName":"toicDemo" 7 } 8 -
请求头域
除公共头域外，无其它特殊头域。
-
请求参数
参数名称 类型 描述 begin requestBody 检索记录开始索引 limit requestBody 要检索的记录数 topicName requestBody topic名称
返回
-
返回头域
除公共头域，无其它特殊头域。
- 返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| begin | Integer | 检索记录开始索引 |
| limit | Integer | 要检索的记录数 |
| consumerGroups | List |
consumerGroups信息，由consumerGroup组成的集合 |
错误码
无
示例
- 请求示例
Plain Text
1POST /v1/consumergroups/list
2authorization: bce-auth-v1/32d21dc5-b643-4769-864b-54e3a8868d89/2017-02-16T02:17:25Z/3600/host;x-bce-console-rpc-id;x-bce-date/03a0254357eafd041eb61a2610e938904733cc06a0d3994a7985b62a284874bd
3x-bce-console-rpc-id: 010ce7dc-e454-43ae-a950-75609b39c580
4host: kafka-api.bj.baidubce.com
5x-bce-date: 2017-02-16T02:17:25Z
6content-type: application/json
7user-agent: Jersey/2.9.1 (Apache HttpClient 4.3.3)
8content-length: 53
9connection: Keep-Alive
10accept-encoding: gzip,deflate
11
12 {
13 "begin":1,
14 "limit":10,
15 "topicName":"toicDemo"
16 }- 返回示例
Plain Text
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3Cache-Control: no-cache
4Server: BWS
5Date: Thu, 16 Feb 2017 02:17:26 GMT
6Content-Type: application/json;charset=UTF-8
7
8 {
9 "begin": 0,
10 "size": 10,
11 "groupIds": ["group1","group2"]
12 }
13