生成接入凭证
功能介绍
接入凭证是用于客户端使用AMQP等协议与平台建链的一个认证凭据。只保留一条记录，如果重复调用只会重置接入凭证，使得之前的失效。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v5/iot/{project_id}/auth/accesscode
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 最小长度：0 最大长度：36 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
type |
否 |
String |
参数说明：接入凭证类型，默认为AMQP的接入凭证类型。 取值范围：
最小长度：0 最大长度：16 |
force_disconnect |
否 |
Boolean |
参数说明: 是否将AMQP/MQTT连接断开 缺省值：false |
响应参数
状态码： 201
参数 |
参数类型 |
描述 |
|---|---|---|
access_key |
String |
接入名，随机生成8位字符串 最小长度：0 最大长度：8 |
access_code |
String |
接入凭证。 最小长度：0 最大长度：1024 |
请求示例
生成接入凭证，接入凭证类型为amqp。
POST https://{endpoint}/v5/iot/{project_id}/auth/accesscode
{
"type" : "AMQP"
}
响应示例
状态码： 201
Created
{
"access_key" : "examples",
"access_code" : "examples"
}
状态码
状态码 |
描述 |
|---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
FORBIDDEN |
500 |
Internal Server Error |
错误码
请参见错误码。
