调用GetHandshake获取邀请信息-阿里云帮助中心

使用说明

本文将提供一个示例，获取ID为h-ycm4rp****的邀请信息。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetHandshake	要执行的操作。取值：GetHandshake。
HandshakeId	String	是	h-ycm4rp****	邀请ID。

关于公共请求参数的详情，请参见公共参数。

返回数据


名称	类型	示例值	描述
RequestId	String	9B34724D-54B0-4A51-B34D-4512372FE1BE	请求ID。
Handshake	Object		邀请信息。
Status	String	Pending	邀请状态。 Pending：等待确认。 Accepted：已接受。 Cancelled：已取消。 Declined：已拒绝。 Expired：超时。
ExpireTime	String	2018-08-24T09:55:41Z	邀请的过期时间（UTC时间）。
CreateTime	String	2018-08-10T09:55:41Z	邀请的创建时间（UTC时间）。
TargetEntity	String	someone@example.com	被邀请账号ID或登录邮箱。
MasterAccountId	String	172841235500****	资源目录管理账号ID。
HandshakeId	String	h-ycm4rp****	邀请ID。
MasterAccountRealName	String	company	资源目录管理账号实名认证信息。说明被邀请方调用此接口时，才能查看该参数。
ResourceDirectoryId	String	rd-abcdef****	资源目录ID。
InvitedAccountRealName	String	Alice	被邀请方实名认证信息。说明被邀请方调用此接口时，才能查看该参数。
Note	String	欢迎您加入	备注。
MasterAccountName	String	company@example.com	资源目录管理账号名称。
TargetType	String	Email	被邀请账号类型。 Account：账号ID。 Email：账号登录邮箱。
ModifyTime	String	2018-08-10T09:55:41Z	邀请的修改时间（UTC时间）。

示例

请求示例

https://resourcemanager.aliyuncs.com/?Action=GetHandshake
&HandshakeId=h-ycm4rp****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetHandshakeResponse>
    <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>
    <Handshake>
        <HandshakeId>h-ycm4rp****</HandshakeId>
        <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>
        <MasterAccountId>172841235500****</MasterAccountId>
        <MasterAccountName>company@example.com</MasterAccountName>
        <MasterAccountRealName>company</MasterAccountRealName>
        <InvitedAccountRealName>Alice</InvitedAccountRealName>
        <TargetEntity>someone@example.com</TargetEntity>
        <TargetType>Email</TargetType>
        <Note>欢迎您加入</Note>
        <Status>Pending</Status>
        <CreateTime>2018-08-10T09:55:41Z</CreateTime>
        <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>
        <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>
    </Handshake>
</GetHandshakeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "Handshake" : {
    "HandshakeId" : "h-ycm4rp****",
    "ResourceDirectoryId" : "rd-abcdef****",
    "MasterAccountId" : "172841235500****",
    "MasterAccountName" : "company@example.com",
    "MasterAccountRealName" : "company",
    "InvitedAccountRealName" : "Alice",
    "TargetEntity" : "someone@example.com",
    "TargetType" : "Email",
    "Note" : "欢迎您加入",
    "Status" : "Pending",
    "CreateTime" : "2018-08-10T09:55:41Z",
    "ModifyTime" : "2018-08-10T09:55:41Z",
    "ExpireTime" : "2018-08-24T09:55:41Z"
  }
}

错误码


HttpCode	错误码	错误信息	描述
400	MissingParameter.HandshakeId	You must specify HandshakeId.	邀请ID缺失，请指定目标ID。
400	InvalidParameter.HandshakeId	The HandshakeId is invalid.	邀请ID无效，邀请ID应以“h-”开头+16位数字或英文字母。
404	EntityNotExists.Handshake	The specified handshake does not exist.	邀请不存在，请指定正确的邀请。
409	HandshakeStatusMismatch	The invitation is invalid.	握手状态不匹配或邀请已失效。
409	MissingAccountRealName	The name of the invited account is not specified.	该邀请账号没有名称信息。
409	NoRealNameAuthentication	The account invited has not passed real-name authentication.	被邀请账号无实名认证。

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