文档首页/ 组织 Organizations/ API参考/ API/ 账号管理/ 列出关闭账号的状态
更新时间：2024-10-21 GMT+08:00
查看PDF
分享

列出关闭账号的状态

功能介绍

列出组织中指定状态的账号关闭请求。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET https://{endpoint}/v1/organizations/close-account-status

表1 Query参数

参数

是否必选

参数类型

描述

states

否

Array of strings

要包含在响应中的一个或多个状态的列表。如果此参数不存在，则所有请求都包含在响应中。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

close_account_statuses

Array of CloseAccountStatusDto objects

包含有关请求的详细信息的对象列表。
表4 CloseAccountStatusDto

参数

参数类型

描述

account_id

String

账号的唯一标识符（ID）。

created_at

String

请求关闭账号的日期和时间。

updated_at

String

请求关闭账号状态更新的日期和时间。

organization_id

String

组织的唯一标识符（ID）。

state

String

关闭账号的状态，pending_closure：关闭中，suspended：已关闭

failure_reason

String

如果请求失败，则说明失败原因。

请求示例

列出关闭账号的状态

GET https://{endpoint}/v1/organizations/close-account-status

响应示例

状态码： 200

Successful

{
  "close_account_statuses" : [ {
    "account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
    "updated_at" : "2022-08-24T06:41:15Z",
    "created_at" : "2022-08-24T06:41:15Z",
    "organization_id" : "o-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
    "state" : "pending_closure",
    "failure_reason" : "string"
  } ]
}

状态码

状态码

描述

200

Successful

错误码

请参见错误码。

父主题： 账号管理