全部产品
Search

搜索本产品

    资源管理：CancelHandshake - 取消邀请

    文档中心

    资源管理：CancelHandshake - 取消邀请

    更新时间：Apr 24, 2024

    调用CancelHandshake取消邀请。

    接口说明

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

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    resourcemanager:CancelHandshakeWrite
    • Handshake
      acs:resourcemanager:*:{#accountId}:handshake/{#HandshakeId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    HandshakeIdstring是

    邀请 ID。

    		h-ycm4rp****

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    		9B34724D-54B0-4A51-B34D-4512372FE1BE
    Handshakeobject

    邀请信息。

    Statusstring

    邀请状态。取值：

    • Pending：等待确认。
    • Accepted：已接受。
    • Cancelled：已取消。
    • Declined：已拒绝。
    • Expired：超时。
    		Cancelled
    ExpireTimestring

    邀请的过期时间（UTC 时间）。

    		2018-08-24T09:55:41Z
    ResourceDirectoryIdstring

    资源目录 ID。

    		h-ycm4rp****
    CreateTimestring

    邀请的创建时间（UTC 时间）。

    		2018-08-10T09:55:41Z
    Notestring

    备注。

    		欢迎您加入
    TargetEntitystring

    被邀请账号 ID 或登录邮箱。

    		someone@example.com
    MasterAccountIdstring

    资源目录管理账号 ID。

    		172841235500****
    MasterAccountNamestring

    资源目录管理账号名称。

    		Alice
    ModifyTimestring

    邀请的修改时间（UTC 时间）。

    		2018-08-10T09:55:41Z
    TargetTypestring

    被邀请账号类型。取值：

    • Account：账号 ID。
    • Email：账号登录邮箱。
    		Email
    HandshakeIdstring

    邀请 ID。

    		h-ycm4rp****

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400MissingParameter.HandshakeIdYou must specify HandshakeId.邀请ID缺失，请指定目标ID。
    400InvalidParameter.HandshakeIdThe HandshakeId is invalid.邀请ID无效，邀请ID应以“h-”开头+16位数字或英文字母。
    404EntityNotExists.HandshakeThe specified handshake does not exist.邀请不存在，请指定正确的邀请。
    409HandshakeStatusMismatchThe invitation is invalid.握手状态不匹配或邀请已失效。

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史