生成接入凭证 - CreateAccessCode
功能介绍
接入凭证是用于客户端使用AMQP等协议与平台建链的一个认证凭据。只保留一条记录,如果重复调用只会重置接入凭证,使得之前的失效。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/iot/{project_id}/auth/accesscode
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数说明:项目ID。获取方法请参见 获取项目ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Instance-Id | 否 | String | 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考 查看实例详情。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 否 | String | 参数说明:接入凭证类型,默认为AMQP的接入凭证类型。 取值范围:
|
| force_disconnect | 否 | Boolean | 参数说明: 是否将AMQP/MQTT连接断开 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| access_key | String | 接入名,随机生成8位字符串 |
| access_code | String | 接入凭证。 |
请求示例
生成接入凭证,接入凭证类型为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 |
错误码
请参见错误码。