POST https://ark.cn-beijing.volcengineapi.com/?Action=ListSeatInfos&Version=2024-01-01
获取当前账户下所有席位的基础信息列表,支持按套餐类型、席位状态、计费状态等条件筛选,并支持分页和排序。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
Filter object 必选 | 筛选条件
筛选条件,用于精准过滤席位。
BillingStatus integer[] | 计费状态
Filter.BillingStatus
席位计费状态。支持的取值:
1:pending,已下单未付费2:running,已激活3:expired,已过期4:reclaimed,已回收
BizInfo string | 套餐类型
Filter.BizInfo
席位套餐类型。支持的取值:
LitePro
SeatIDs string[] | 席位 ID 列表
Filter.SeatIDs
席位 ID 列表,单次请求最多携带 1000 个。
SeatStatus integer | 绑定状态
Filter.SeatStatus
席位绑定状态。支持的取值:
1:Idle,空闲状态,席位未绑定 APIKey2:Active,已绑定状态,席位已绑定 APIKey
UserID string | 用户 ID
Filter.UserID
席位绑定的子用户 ID。
UserName string | 用户名
Filter.UserName
席位绑定的子用户名。
PageNum integer | 页码
分页页码,从 1 开始。
PageSize integer | 每页数量
每页返回的席位数量。
ProjectName string 默认值 default | 项目名称
项目名称,资源不在默认项目中时需填写实际项目名称。
Scene string 默认值 coding_plan_enterprise | 场景
企业版席位的业务场景。支持的取值:
coding_plan_enterprise:Coding Plan 企业版席位agent_plan_enterprise:Agent Plan 企业版席位。查询 Agent Plan 企业版席位时需显式传入该值,否则返回结果为空。
SortBy string | 排序字段
排序字段,例如 OrderTimestamp 表示按下单时间排序。
SortOrder string | 排序方向
排序方向。支持的取值:
Asc:升序Desc:降序
TagFilters object[] | 标签筛选条件
按席位绑定的标签筛选,多条之间为「与」关系,同一 Key 的多个 Values 之间为「或」关系。
Key string 必选 | 标签键
TagFilters.Key
用于筛选席位的标签键。
Values string[] | 标签值列表
TagFilters.Values
用于筛选席位的标签值列表,多值为「或」关系。
响应参数#
BizSummaries object[] | 套餐统计汇总
各套餐席位的统计汇总。
ActiveCount integer | 已绑定席位数
BizSummaries.ActiveCount
该套餐下已绑定的席位数(SeatStatus 为 Active)。
BizInfo string | 套餐类型
BizSummaries.BizInfo
席位套餐类型。支持的取值:
LitePro
TotalCount integer | running 席位总数
BizSummaries.TotalCount
该套餐下 running 状态的席位总数。
Data object[] | 席位详情列表
符合查询条件的席位详情数组。
SeatID string | 席位 ID
Data.SeatID
席位唯一标识 ID。
AccountID string | 主账号 ID
Data.AccountID
席位所属火山引擎主账号 ID。
ProjectName string | 项目名称
Data.ProjectName
席位所属项目名称。
BizInfo string | 套餐类型
Data.BizInfo
席位套餐类型。支持的取值:
LitePro
BillingStatus integer | 计费状态
Data.BillingStatus
席位计费状态。支持的取值:
1:pending,已下单未付费2:running,已激活3:expired,已过期4:reclaimed,已回收
InstanceID string | 计费实例 ID
Data.InstanceID
计费模块返回的实例 ID。
OrderTime integer | 下单时间
Data.OrderTime
最近一次下单时间,Unix 时间戳,单位为秒。
ExpiredTime integer | 到期时间
Data.ExpiredTime
最近一次下单的到期时间,Unix 时间戳,单位为秒。
AutoRenew boolean | 自动续费
Data.AutoRenew
是否开启自动续费。取值:
true:开启自动续费false:关闭自动续费
SubscribeMilestones string | 资源刷新时间
Data.SubscribeMilestones
席位资源刷新的时间节点。
RateLimit object | 限流配置
Data.RateLimit
席位的限流配置。
RPM integer | RPM
Data.RateLimit.RPM
Requests Per Minute,每分钟允许的请求数。
TokenWindow object[] | 限流时间窗口
Data.RateLimit.TokenWindow
Token 限流时间窗口配置列表。
DurationSeconds integer | 窗口长度(秒)
Data.RateLimit.TokenWindow.DurationSeconds
限流时间窗口长度,单位为秒。
Token integer | 窗口 Token 上限
Data.RateLimit.TokenWindow.Token
当前时间窗口内允许使用的 Token 上限。
TPM integer | TPM
Data.RateLimit.TPM
Tokens Per Minute,每分钟允许处理的 Token 总量。
ExtraConfig object | 扩展配置
Data.ExtraConfig
席位扩展配置。
ArkCodeLatestMappingModelID string | ark-code-latest 映射
Data.ExtraConfig.ArkCodeLatestMappingModelID
别名 ark-code-latest 当前映射到的具体模型 ID。
SeatStatus string | 绑定状态
Data.SeatStatus
席位绑定状态。支持的取值:
1:Idle,空闲状态,席位未绑定 APIKey2:Active,已绑定状态,席位已绑定 APIKey
IdentityType string | 身份类型
Data.IdentityType
席位绑定的身份类型,例如 SubUser 表示子用户。
IdentityId string | 身份 ID
Data.IdentityId
席位绑定的身份 ID,例如子用户 ID。
IdentityDetail string | 身份附加信息
Data.IdentityDetail
席位绑定的身份附加信息,例如用户名。
BindCount integer | 本月绑定次数
Data.BindCount
本月席位绑定次数。
ApiKeySID string | APIKey SID
Data.ApiKeySID
APIKey 唯一标识,用于 APIKey 轮换。
ApiKey string | APIKey 密钥
Data.ApiKey
席位绑定的 APIKey 密钥。
CreateTime integer | 创建时间
Data.CreateTime
席位创建时间,Unix 时间戳,单位为秒。
UpdateTime string | 更新时间
Data.UpdateTime
席位更新时间,ISO 8601 格式。
Scene string | 场景
Data.Scene
席位所属的业务场景。支持的取值:
coding_plan_enterprise:Coding Plan 企业版席位agent_plan_enterprise:Agent Plan 企业版席位
Version integer | 版本号
Data.Version
乐观锁版本号。
Total integer | 席位总数
符合查询条件的席位总数量。