DescribeAccount - 查询成员账号信息--企业组织-火山引擎

文档中心

立即注册

导航

DescribeAccount - 查询成员账号信息

最近更新时间：2024.01.11 17:42:36首次发布时间：2024.01.11 17:42:36

查询成员账号信息

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeAccount	要执行的操作，取值：DescribeAccount
Version	String	是	2022-01-01	API的版本，取值：2022-01-01
AccountId	String	是		成员账号ID

响应数据

名称	类型	描述
ID	String	账号ID
CreatedTime	String	创建时间
UpdatedTime	String	更新时间
DeletedTime	String	删除时间
Owner	String	管理员ID
OrgID	String	组织ID
OrgType	Integer	组织类型，1.企业组织
OrgUnitID	String	组织单元ID
OrgVerificationID	String	认证主体ID
AccountID	String	账号ID
AccountName	String	账号名称
ShowName	String	显示名称
Description	String	描述
IamRole	String	IAM角色名称
JoinType	Integer	加入类型, 1创建，2邀请
AllowConsole	Integer	允许控制台访问，1允许，2不允许
AllowExit	Integer	允许退出，1允许，2不允许
MainName	String	主体名称
DeleteUk	String	删除标记

示例

请求

GET /?Action= DescribeAccount&Version=2022-01-01 
--header 'Content-Type: application/json' \
-d '{"OrgId": 0011223344556677889","AccountId": "2100111111"}'

响应

{
    "ResponseMetadata": {
        "RequestId": "2023101317504910D9BB00C4D5AD5BA849",
        "Action": "DescribeAccount",
        "Version": "2022-01-01",
        "Service": "organization",
        "Region": "cn-north-1"
    },
    "Result": {
        "Account": {
            "ID": "1122334455667788990",
            "CreatedTime": "2023-03-02T19:36:59+08:00",
            "UpdatedTime": "2023-03-02T20:40:03+08:00",
            "Owner": "2111111111",
            "OrgID": "0011223344556677889",
            "OrgType": 1,
            "OrgUnitID": "0011223344556677889",
            "OrgVerificationID": "0011223344556677889",
            "AccountID": "2111111111",
            "AccountName": "owner",
            "ShowName": "owner",
            "Description": "description",
            "IamRole": "",
            "JoinType": 1,
            "AllowConsole": 1,
            "AllowExit": 2,
            "MainName": "主体名称*********"
        }
    }
}

错误码

下表提供了该接口业务逻辑相关的错误码。公共错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
500	InternalError	Unknown internal error: %v	未知错误，根据错误信息判断详情
400	PermissionError	No permission to perform action[%s] on resource %s	无权限，没有对该资源进行该操作的权限
400	InvalidParam	The parameter %v[%v] is invalid.	参数不合法
404	RecordNotExists	record %s not exists	记录不存在