状态码
请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码 列表请参见状态码。
对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。
响应消息头
对应请求消息头,响应同样也有消息头,如“Content-type”。
对于获取用户Token接口,返回如图3-2所示的消息头,其中“x-subject-token”就是 需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
图3-2 获取用户 Token 响应消息头
响应消息体(可选)
响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应 消息头之外的内容。
对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。
{ "token": {
"expires_at": "2019-02-13T06:52:13.855000Z", "methods": [
"password"
],
"catalog": [ {
"endpoints": [ {
"region_id": "XXXXXX", ...
当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所 示。
{ "error_msg": "The format of message is error", "error_code": "AS.0001"
}
其中,error_code表示错误码,error_msg表示错误描述信息。
4 快速入门
场景描述
您可以根据业务需要创建相应计算能力和存储空间的Kafka实例。
API调用方法请参考如何调用API。
前提条件
● 已获取IAM的Endpoint,具体请参见地区和终端节点。
● 已获取Kafka的Endpoint,具体请参见地区和终端节点。
创建 Kafka 实例
如下示例是创建Kafka实例的请求消息:
{ "name": "kafka-demo", "engine": "kafka", "engine_version": "2.3.0", "specification": "100MB", "storage_space": 600, "partition_num": 300,
"vpc_id": "60fc80a5-35db-45a9-acdb-0ef2361e1088",
"security_group_id": "d8c81e0f-de6a-4110-8c96-81af3eacb3d1", "subnet_id": "45767e73-a093-4a1c-8cdd-b8d664b34dcc", "available_zones": [
"72d50cedc49846b9b42c21495f38d81c"
], "product_id": "00300-30308-0--0", "kafka_manager_user": "test", "kafka_manager_password": "Z****x",
"storage_spec_code": "dms.physical.storage.high"
}
● name:实例名称,由您自行定义。
● engine:消息引擎,设置kafka。
● engine_version:消息引擎的版本。
● specification:Kafka实例的基准带宽。具体取值范围,请参考“创建实例(按 需)”章节。
● storage_space:消息存储空间,单位GB。具体取值范围,请参考“创建实例(按 需)”章节。
● partition_num:Kafka实例的最大分区数量。具体取值范围,请参考“创建实例
(按需)”章节。
● vpc_id:Kafka实例所在的VPC(虚拟私有云)的ID。您可以在虚拟私有云控制台 中查询,也可以通过查询VPC列表API查询。
● security_group_id:安全组ID。您可以在虚拟私有云控制台中查询,也可以通过 查询安全组列表API查询。
● subnet_id:VPC内子网的网络ID。您可以在虚拟私有云控制台中查询,也可以通 过查询子网列表API查询。
● available_zones:创建节点到指定的AZ ID,该参数不能为空数组或者数组的值为 空,请参考“查询可用区信息”章节获取。
● product_id:产品标识。请参考“查询产品规格列表”章节获取。
● kafka_manager_user:登录Kafka Manager的用户名,由您自行定义。
● kafka_manager_password:登录Kafka Manager的用户名密码,由您自行定义。
● storage_spec_code:存储IO规格。具体取值范围,请参考“创建实例(按需)”
章节。