调用 ListSubAccountOrganizations
接口获取子账号的组织列表,包含组织的 ID 和名称。
注意事项
- 请求频率:单用户请求频率限制为 10 次/秒。
- 前提条件:确保您拥有火山引擎主账号或具备账户中心 > 权限管理 > 仅查看或可编辑权限的子账号。有关如何添加子账号,详见子账号管理。
请求说明
- 请求方式:GET
- 请求地址:https://livesaas.volcengineapi.com/?Action=ListSubAccountOrganizations&Version=2023-08-01
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
Action | String | 是 | ListSubAccountOrganizations | 接口名称。当前 API 的名称为 ListSubAccountOrganizations 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
KeyWord | String | 否 | A | 组织名称。支持模糊搜索,大小写不敏感。 例如,该参数取值为 A ,则返回组织 A 、组织 ab 等名称的组织。 |
PageNumber | Integer | 否 | 1 | 分页查询页码。默认值为 1 。取值大于等于 1 。 |
PageSize | Integer | 否 | 100 | 分页查询数量。默认值为 10 。取值范围为 [1,100]。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
---|
TotalCount | Long | 1 | 查询结果总数。 |
Organizations | Array of Organizations | - | 组织列表。 |
Organizations
参数 | 类型 | 示例值 | 描述 |
---|
Id | Long | 181432****480235 | 组织 ID。 |
Name | String | 组织 A | 组织名称。 |
请求示例
GET https://livesaas.volcengineapi.com/?Action=ListSubAccountOrganizations&Version=2023-08-01&KeyWord=A&PageNumber=1&PageSize=100
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "ListSubAccountOrganizations",
"Version": "2023-08-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"TotalCount": 1,
"Organizations": [
{
"Id": 181432****480235,
"Name": "组织 A"
}
]
}
}
错误码
访问公共错误码和错误码获取详细信息。