POST https://ark.cn-beijing.volcengineapi.com/?Action=ListAuthorizedCommercialIPIds&Version=2024-01-01
查询当前账号已领用且仍然有效的商业 IP 精简信息列表。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
IPCategory string | IP 展示分类
按展示分类筛选已授权商业 IP。不传时返回全部分类。可选值:REAL_PERSON、VISUAL_WORKS。
响应参数#
Items object[] | 商业 IP 列表
当前账号已领用且仍然有效的商业 IP 精简信息列表,按 IP ID 升序返回。
IPCategory string | IP 展示分类
Items.IPCategory
商业 IP 的展示分类。可选值:REAL_PERSON、VISUAL_WORKS。
IpId string | 商业 IP ID
Items.IpId
商业 IP ID,格式为 ip-c-*。
IPName string | IP 名称
Items.IPName
商业 IP 的展示名称。
DescriptionCN string | 中文说明
Items.DescriptionCN
商业 IP 的中文说明。
DescriptionEN string | 英文说明
Items.DescriptionEN
商业 IP 的英文说明。
SupportsAuthLetterApplication boolean | 是否支持授权书申请
Items.SupportsAuthLetterApplication
表示该商业 IP 是否支持授权书申请。true 表示支持申请,但不代表提交申请时一定通过校验;创建授权书申请时仍会校验 IP 上下架状态、当前账号领用状态和申请表单等条件。