调用GetAuthToken获取长连接建连Token,客户端可以用此Token通过LWP协议和各个原子能力进行长连接通信。
接口说明
该接口一般使用流程是客户端获取UserId、DeviceId信息,然后传入到服务端,服务端使用该接口获取鉴权Token,并返回给客户端。不同的用户需要使用不同的UserId,不同的终端设备需要使用不同的DeviceId。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imp:GetAuthToken | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。 | 7m***q |
AppKey | string | 是 | 通过控制台创建和查询。小写英文和数字,长度32个字符。 | 06***9c |
UserId | string | 是 | 用户UserId,用户自定义,在AppId下单独唯一。小写英文、数字、下划线(_)和小数点(.)组成,最大长度32个字符。不同的用户需要使用不同的UserId。 | as****hs |
DeviceId | string | 是 | 终端设备ID,唯一代表一个用户终端设备,用户自定义。小写英文、数字、下划线(_)和短横线(-)组成,最大长度64个字符。不同终端设备需要使用不同的DeviceId,建议从终端设备获取并传入给服务端。 | a494caec-***-695ef345db77 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
"Result": {
"AccessToken": "oauth_cloud_key:***-b0YY5Gy6Q",
"RefreshToken": "oauth_cloud_key:****-Q62xggOTdgk3gw=",
"AccessTokenExpiredTime": 86400000
}
}
XML
格式
<GetAuthTokenResponse>
<RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
<Result>
<AccessToken>oauth_cloud_key:***-b0YY5Gy6Q</AccessToken>
<RefreshToken>oauth_cloud_key:****-Q62xggOTdgk3gw=</RefreshToken>
<AccessTokenExpiredTime>86400000</AccessTokenExpiredTime>
</Result>
</GetAuthTokenResponse>
错误码
访问错误中心查看更多错误码。