You need to enable JavaScript to run this app.
导航
ListAccounts - 获取企业组织内账号列表
最近更新时间:2025.02.06 22:24:06首次发布时间:2024.01.11 17:42:35

获取企业组织内账号列表

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ListAccounts

要执行的操作,取值:ListAccounts。

Version
String

2022-01-01

API的版本,取值:2022-01-01。

Limit
Integer

10

每一页显示数量,默认 10,最大 100

Offset
Integer

1

页数,起始值1

OrgUnitId
String

1

组织单元ID

VerificationId
String

1

认证主体ID

Search
String

id

显示名称或成员账号Id模糊查询

OrderBy
Integer

1

排序顺序,1.降序 2.升序,默认为1

IncludeTags
Boolean

false

是否返回tags信息

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Offset
Integer

1

页数

Limit
Integer

10

每一页显示数量

Total
Integer

100

总数

AccountList
Array of Object

"AccountList": [
{
"ID": "Z4CdjhMv0",
"CreatedTime": "7",
"UpdatedTime": "jT4Mn",
"DeletedTime": "jPyxH",
"Owner": "UOdHW1D1D",
"OrgID": "ufd5mYn7",
"OrgUnitID": "k",
"OrgVerificationID": "O5HpiM",
"AccountID": "Bed0Bi",
"AccountName": "CDpEwu37",
"ShowName": "pv",
"Description": "hNLqT2dC",
"IamRole": "23HY",
"JoinType": 1,
"AllowExit": 2,
"AllowConsole": 2,
"OrgUnitName": "Xi3tND5NR",
"IsOwner": 687,
"DeleteUk": "8z9Sbede",
"Tags": [
{
"Key": "86uthgqPVY",
"Value": "5"
}
],
"OrgType": 455
}
]

账号列表

请求示例

POST /?Action=ListAccounts&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250206T072640Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250206/cn-beijing/organization/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Limit": 10,
  "Offset": 1,
  "OrgUnitId": "1",
  "VerificationId": "1",
  "Search": "id",
  "OrderBy": 1,
  "IncludeTags": false
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250206152656248187020101AFB28F",
    "Action": "ListAccounts",
    "Version": "2022-01-01",
    "Service": "organization",
    "Region": "cn-beijing"
  },
  "Result": {
    "Offset": 1,
    "Limit": 10,
    "Total": 100,
    "AccountList": [
      {
        "ID": "Z4CdjhMv0",
        "CreatedTime": "7",
        "UpdatedTime": "jT4Mn",
        "DeletedTime": "jPyxH",
        "Owner": "UOdHW1D1D",
        "OrgID": "ufd5mYn7",
        "OrgUnitID": "k",
        "OrgVerificationID": "O5HpiM",
        "AccountID": "Bed0Bi",
        "AccountName": "CDpEwu37",
        "ShowName": "pv",
        "Description": "hNLqT2dC",
        "IamRole": "23HY",
        "JoinType": 1,
        "AllowExit": 2,
        "AllowConsole": 2,
        "OrgUnitName": "Xi3tND5NR",
        "IsOwner": 687,
        "DeleteUk": "8z9Sbede",
        "Tags": [
          {
            "Key": "86uthgqPVY",
            "Value": "5"
          }
        ],
        "OrgType": 455
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
PermissionError

No permission to perform action[%s] on resource %s

无权限,没有对该资源进行该操作的权限

404
RecordNotExists

record %s not exists

记录不存在

500
InternalError

Unknown internal error: %v

未知错误,根据错误信息判断详情