You need to enable JavaScript to run this app.
导航
ListInvitations - 查询全部加入企业组织邀请
最近更新时间:2025.02.06 22:25:50首次发布时间:2024.01.11 17:42:35

查询全部加入企业组织邀请

调试

请求参数

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

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

ListInvitations

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

Version
String

2022-01-01

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

Offset
Integer

1

分页,第一页为1

Limit
Integer

10

分页大小,默认10,最大 100

OrgUnitId
String

1

组织单元Id

Search
String

id

按显示名或账号Id模糊查询

OrderStr
String

created_time

排序字段,"created_time","updated_time",默认created_time

OrderBy
Integer

1

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

返回参数

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

参数
类型
示例值
描述
InvitationList
Array of Object

"InvitationList": [
{
"ID": "uwQQWzP",
"OrgUnitName": "jOp",
"ExTime": "J3RHyNMkGh",
"CreatedTime": "9",
"UpdatedTime": "Xi",
"DeletedTime": "t0JVSSNO4",
"Owner": "98csz0",
"OrgID": "kcm",
"OrgUnitID": "9oDGl",
"AccountID": "D8",
"AccountName": "zc2tlRnc",
"LinkID": "Gh1fTF24",
"Description": "fqbXwz",
"ShowName": "RPPG",
"AllowExit": "",
"Status": "",
"RejectReason": "mfmLY",
"DeleteUk": "LASwOeWQe0"
}
]

账号邀请详情

Offset
Integer

1

分页,第一页为1

Limit
Integer

10

分页大小,默认10

Total
Integer

100

总数

请求示例

POST /?Action=ListInvitations&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250206T072813Z
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

{
  "Offset": 1,
  "Limit": 10,
  "OrgUnitId": "1",
  "Search": "id",
  "OrderStr": "created_time",
  "OrderBy": 1
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202502061528221382210601610C9C27",
    "Action": "ListInvitations",
    "Version": "2022-01-01",
    "Service": "organization",
    "Region": "cn-beijing"
  },
  "Result": {
    "InvitationList": [
      {
        "ID": "uwQQWzP",
        "OrgUnitName": "jOp",
        "ExTime": "J3RHyNMkGh",
        "CreatedTime": "9",
        "UpdatedTime": "Xi",
        "DeletedTime": "t0JVSSNO4",
        "Owner": "98csz0",
        "OrgID": "kcm",
        "OrgUnitID": "9oDGl",
        "AccountID": "D8",
        "AccountName": "zc2tlRnc",
        "LinkID": "Gh1fTF24",
        "Description": "fqbXwz",
        "ShowName": "RPPG",
        "AllowExit": "",
        "Status": "",
        "RejectReason": "mfmLY",
        "DeleteUk": "LASwOeWQe0"
      }
    ],
    "Offset": 1,
    "Limit": 10,
    "Total": 100
  }
}

错误码

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

状态码
错误码
错误信息
说明
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

记录不存在

500
InternalError

Unknown internal error: %v

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