调用DescribeSession接口,获取指定登录态信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSession

系统规定参数。取值:DescribeSession。

SessionId Integer 1

登录态ID,用于获取登录态信息。

返回数据

名称 类型 示例值 描述
RequestId String DD73CB0A-6E99-49AB-9569-5A00C9732795

返回结果的请求ID。

Session

登录态Session信息。

AliUid Integer 12345678

用户UID信息。

Asset String foo.com

资产名称。查询指定资产下的检测数据。

CreatedAt Long 1561392000000

登录态创建时间戳。用户创建登录态的时间。

Expired Integer 0

登录态是否过期。0 代表未过期,1 代表过期。

LoginSession String Cookie: gr_user_id=b7c48e18-1b4b-4c55-9281-b961a1022d40;

登录态 Cookie 信息。目前只支持 Cookie 格式,添加的时候需要加上 "Cookie: " 前缀。

ModifiedAt Long 1561392000000

登录态最新修改时间戳。用户修改登录态的最新时间。

SessionId Integer 1

登录态SessionID。

TTL Integer 3600

登录态过期时间。您可以设定此过期时间来判断登录态是否过期。

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeSession
&<公共请求参数>

正常返回示例

XML 格式

<code>200</code>
<success>true</success>
<requestId>9D2C9710-A52C-4C4A-9082-9E570C958D5D</requestId>
<data>
    <Total>120</Total>
    <Session>
        <Expired>3600</Expired>
        <LoginSession>Cookie: gr_user_id=b7c48e18-1b4b-4c55-9281-b961a1022d40</LoginSession>
        <CreatedAt>1561392000000</CreatedAt>
        <AliUid>1234567789</AliUid>
        <SessionId>48</SessionId>
        <Asset>www.foo.cn</Asset>
        <ModifiedAt>1561392000000</ModifiedAt>
        <TTL>10</TTL>
    </Session>
</data>

JSON 格式

{
	"requestId":"9D2C9710-A52C-4C4A-9082-9E570C958D5D",
	"data":{
		"Session":{
			"SessionId":48,
			"ModifiedAt":1561392000000,
			"AliUid":"1234567789",
			"Expired":3600,
			"Asset":"www.foo.cn",
			"LoginSession":"Cookie: gr_user_id=b7c48e18-1b4b-4c55-9281-b961a1022d40",
			"TTL":10,
			"CreatedAt":1561392000000
		},
		"Total":120
	},
	"code":"200",
	"success":true
}

错误码

访问错误中心查看更多错误码。