Kafka 公开API目录

• API概览
• 认证方式.md#认证方式)
  • 1.公共请求参数.md#1公共请求参数)
  • 2.签名机制.md#2签名机制)
    • 步骤一：构造规范化请求字符串.md#步骤一构造规范化请求字符串)
    • 步骤二：构造签名字符串.md#步骤二构造签名字符串)
  • 3.获取签名代码.md#2获取签名代码)
• 错误码
• 访问地址
• 实例
  • 1.GetKafkaList

API概览

Kafka产品提供以下相关API接口。

实例

访问地址

1.GetKafkaList

Action： GetKafkaList

描述： 获取Kafka实例列表

请求地址： cdsapi.capitalonline.net/kafka

请求方法： POST

请求参数：

请求示例：

def get_kafka_list():
        """
        获取Kafka实例列表
        """
        action = "GetKafkaList"
        method = "POST"
        param = {
        }
        url = get_signature(action, self.AK, self.AccessKeySecret, method, self.KafkaUrl, param)
        body = {
            "ProjectId": "b9661xxx-59fe-11eb-b7e7-46d055d59xxx",
            "RegionId": "APAC_Singapore_D",
            "InstanceId": ["94c08xxx-6095-11eb-b408-0242ac11xxxx"]
        }
        res = requests.post(url, json=body)
        print(res.content)
        result = json.loads(res.content)
        print(result)

返回示例：

{
    "Code": "Success",
    "Data": [
        {
            "CreateTime": "2021-03-05 15:22:48",
            "DiskSize": 100,
            "DiskType": "ssd_disk",
            "Endpoint": "xxxxxx1.kafka.yun-paas.com.:9093,xxxxxxxx2.kafka.yun-paas.com.:9093,xxxxxxxx3.kafka.yun-paas.com.:9093",
            "ExpiredTime": "2099-01-01T00:00:00Z",
            "InstanceDeployType": "公网",
            "InstanceId": "968f8714-7d83-11eb-8946-xxxxxxxxxx",
            "InstanceName": "Test",
            "IopsPkg": "1个",
            "KafkaSpec": "4C8G",
            "KafkaVersion": "v2.2.0",
            "MsgRetain": "24小时",
            "NodeNumber": 3,
            "NodesList": [
                {
                    "BrokerId": 1,
                    "CreateTime": "2021-03-05 15:22:48",
                    "NodeId": "0322b342-5ec3-4511-9397-xxxxxxxxxx",
                    "NodeSpec": "4C8G",
                    "NodeStatus": "run",
                    "PrivateIP": "10.240.xx.xx",
                    "UpdateTime": "2021-03-05 15:27:26"
                },
                {
                    "BrokerId": 2,
                    "CreateTime": "2021-03-05 15:22:48",
                    "NodeId": "1865d66b-c84d-4b87-bcfa-xxxxxxxxxx",
                    "NodeSpec": "4C8G",
                    "NodeStatus": "run",
                    "PrivateIP": "10.240.xx.xx",
                    "UpdateTime": "2021-03-05 15:27:26"
                },
                {
                    "BrokerId": 3,
                    "CreateTime": "2021-03-05 15:22:48",
                    "NodeId": "9be45f93-6818-4ed1-bad9-xxxxxxxxxx",
                    "NodeSpec": "4C8G",
                    "NodeStatus": "run",
                    "PrivateIP": "10.240.xx.xx",
                    "UpdateTime": "2021-03-05 15:27:26"
                }
            ],
            "PayType": "按需",
            "RegionId": "CN_Guangzhou_A",
            "RegionName": "中国大陆-广州-可用区A",
            "ServiceStatus": "run",
            "UpdateTime": "2021-03-05 15:27:26",
            "VdcId": "4538821a-5bea-42be-b255-xxxxxxxxxx",
            "VdcName": "TestGuangZhou"
        }
    ],
    "Message": "获取kafka集群列表成功！"
}

返回参数说明：

状态码说明： | 错误码 | 错误信息 | 说明 | | :—————- | :—- | ——————————————————————— | | 20001 | 参数错误 | 请确认VDC信息 |