智能媒资托管数据结构-服务级 API 文档-文档中心-腾讯云

Instance

官方云盘实例信息

被如下接口引用：DescribeOfficialInstances。

名称	类型	描述
InstanceId	String	实例 ID 示例值：tyc9msci
Domain	String	专属域名。如果实例无专属域名，则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：tyc9msci.cofile.net
EffectiveTime	Timestamp ISO8601	生效时间示例值：2021-10-12T03:53:29Z
ExpireTime	Timestamp ISO8601	过期时间。如果为按量计费或永久有效实例，该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：2021-11-12T15:59:59Z
UserLimit	Integer	用户数量。如果为按量计费或不限制用户数量实例，该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：5
StorageLimit	String	存储容量，单位为 Bytes，由于数字类型精度限制，该字段为 String 类型。如果为按量计费或不限制存储容量实例，该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：107374182400
StorageLimitGB	Integer	存储容量，单位为 GB。如果为按量计费或不限制存储容量实例，该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：100
Isolated	Boolean	是否过期隔离示例值：false
AutoRenew	Integer	续费标识。0：手动续费；1：自动续费；2：到期不续。示例值：1
SuperAdminAccount	String	超级管理员账号，如果未选择查询实例绑定的超级管理员账号或当前实例未绑定超级管理员账号，则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：+86-18988888888

Library

PaaS 服务媒体库信息

被如下接口引用：DescribeLibraries。

名称	类型	描述
LibraryId	String	媒体库 ID 示例值：smh3ptyc9mscifdi
Name	String	媒体库友好名称示例值：个人相册
Remark	String	备注示例值：用于家庭内部共享
BucketName	String	媒体库绑定的 COS 存储桶示例值：smh-1250000000
BucketRegion	String	媒体库绑定的 COS 存储桶所在的地域示例值：ap-guangzhou
CreationTime	Timestamp ISO8601	媒体库创建时间示例值：2021-10-12T03:53:29Z
LibraryExtension	LibraryExtension	媒体库配置项
Size	String	媒体库用量，单位为 Bytes，由于数字类型精度限制，该字段为 String 类型。示例值：182736273
DirNum	String	媒体库目录数，由于数字类型精度限制，该字段为 String 类型。示例值：12
FileNum	String	媒体库文件数，由于数字类型精度限制，该字段为 String 类型。示例值：3746

LibraryExtension

媒体库配置项

被如下接口引用：CreateLibrary, DescribeLibraries, ModifyLibrary。

名称	类型	必选	描述
IsFileLibrary	Boolean	否	true 为文件类型媒体库，可存储任何类型文件；false 为媒体类型媒体库，仅可存储照片和视频类型文件。默认为 false。在媒体库创建后不能修改。示例值：true
IsMultiSpace	Boolean	否	true 为多租户空间媒体库，可创建多个租户空间；false 为单租户空间媒体库，不能创建租户空间，仅可使用默认的单一租户空间。默认为 false。在媒体库创建后不能修改。示例值：true
CosStorageClass	String	否	保存至 COS 对象存储的文件的存储类型，仅支持 STANDARD、STANDARD_IA、INTELLIGENT_TIERING、MAZ_STANDARD、MAZ_STANDARD_IA 和 MAZ_INTELLIGENT_TIERING，默认为 STANDARD，当使用多 AZ 存储桶时将自动使用 MAZ_ 开头的用于多 AZ 的存储类型，否则自动使用非 MAZ_ 开头的用于非多 AZ 的存储类型。当指定智能分层存储 INTELLIGENT_TIERING 或 MAZ_INTELLIGENT_TIERING 时，需要事先为存储桶开启智能分层存储，否则将返回失败。在媒体库创建后不能修改。示例值：STANDARD_IA
UseRecycleBin	Boolean	否	是否开启回收站功能。默认为 false。示例值：true
AutoRemoveRecycledDays	Integer	否	当开启回收站时，自动删除回收站项目的天数，不能超过 1095（3 年），指定为 0 则不自动删除，默认为 0。当未开启回收站时，该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：7
EnableSearch	Boolean	否	是否启用文件路径搜索功能。默认为 false。示例值：true
DenyOnQuotaLessThanUsage	Boolean	否	设置媒体库或租户空间配额且配额小于已使用存储量时，是否拒绝设置请求。默认为 false。示例值：true
EnableFileHistory	Boolean	否	是否开启历史版本。默认为 false。示例值：true
FileHistoryCount	Integer	否	当开启历史版本时，指定单个文件保留的历史版本的数量上限，不能超过 999，指定为 0 则不限制，默认为 0。当未开启历史版本时，该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：10
FileHistoryExpireDay	Integer	否	当开启历史版本时，指定历史版本保留的最长天数，不能超过 999，指定为 0 则不限制，默认为 0。当未开启历史版本时，该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：30
MaxDirFileNameLength	Integer	否	目录或文件名的最长长度，不能超过 255，默认为 255。修改该参数不会影响存量目录或文件名，即如果将该字段的值改小，已经存在的长度超过目标值的目录或文件名不会发生变化。示例值：200
IsPublicRead	Boolean	否	是否开启公有读，开启后读操作无需使用访问令牌，默认为 false。仅单租户空间媒体库支持该属性，否则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：true
IsMultiAlbum	Boolean	否	媒体类型媒体库是否开启多相簿，开启后可创建一级目录（即相簿）且媒体文件只能保存在各相簿中，否则不能创建相簿且媒体文件只能保存在根目录。默认为 false。仅单租户空间媒体类型媒体库支持该属性，否则该属性为 null。在媒体库创建后不能修改。注意：此字段可能返回 null，表示取不到有效值。示例值：true
AllowPhoto	Boolean	否	媒体类型媒体库是否允许上传照片，默认为 true。仅单租户空间媒体类型媒体库支持该属性，否则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：true
AllowPhotoExtName	Array of String	否	当媒体类型媒体库允许上传照片时，指定允许的扩展名，默认为空数组，此时将根据文件扩展名对应的 MIME 类型自动判断。仅单租户空间媒体类型媒体库支持该属性，否则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：[ '.jpg', '.png', '.heic' ]
AllowVideo	Boolean	否	媒体类型媒体库是否允许上传视频，默认为 true。仅单租户空间媒体类型媒体库支持该属性，否则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：true
AllowVideoExtName	Array of String	否	当媒体类型媒体库允许上传视频时，指定允许的扩展名，默认为空数组，此时将根据文件扩展名对应的 MIME 类型自动判断。仅单租户空间媒体类型媒体库支持该属性，否则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：[ '.mp4', '.mov' ]
AllowFileExtName	Array of String	否	指定文件类型媒体库允许的文件扩展名，默认为空数组，此时允许上传所有类型文件。仅单租户空间文件类型媒体库支持该属性，否则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：[ '.docx', '.xslx', '.pptx' ]
RecognizeSensitiveContent	Boolean	否	照片上传时是否进行敏感内容鉴定，默认为 false。仅单租户空间媒体库支持该属性，否则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：true

TrafficPackage

流量资源包信息

被如下接口引用：DescribeTrafficPackages。

名称	类型	描述
InstanceId	String	流量资源包所抵扣的实例 ID 示例值：tyc9msci
Domain	String	专属域名。如果实例无专属域名，则该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：tyc9msci.cofile.net
Type	Integer	流量资源包来源类型，0 为付费购买，1 为赠送。示例值：0
Size	String	总流量，单位为 Bytes，由于数字类型精度限制，该字段为 String 类型。示例值：107374182400
SizeGB	Integer	总流量，单位为 GB 示例值：100
Remain	String	剩余流量，单位为 Bytes，由于数字类型精度限制，该字段为 String 类型。示例值：89017835619
Used	String	已使用流量，单位为 Bytes，由于数字类型精度限制，该字段为 String 类型。示例值：18356346781
UsedPercentage	String	已使用百分比，由于数字类型精度限制，该字段为 String 类型。示例值：17.10
EffectiveTime	Timestamp ISO8601	生效时间，即流量资源包的订购时间示例值：2021-10-12T03:53:29Z
ExpireTime	Timestamp ISO8601	过期时间，即所抵扣的实例的过期时间。如果流量资源包所抵扣的实例为按量计费或永久有效实例，该属性为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：2021-11-12T15:59:59Z

UserFilter

用于唯一查找用户的过滤器。

被如下接口引用：CreateUserLifecycle, DeleteUser, DescribeUserLifecycle, ModifyUser。

名称	类型	必选	描述
Key	String	是	过滤类型，当前支持：UserId、PhoneNumber、Email、AccountName、AccountUserId。示例值：PhoneNumber
Value	String	是	过滤值，只支持完全匹配，不支持模糊搜索。针对不同的 Key，Value 的取值如下： UserId: user12345678abcde PhoneNumber: +86-13800000000（格式为：{CountryCode}-{PhoneNumber}） Email: admin@mail.foobar.com AccountName: account_name AccountUserId: x53mYVqykfPqTCqekbNwwa4aXk4 示例值：+86-13800000000

数据结构

本页目录：

Instance

Library

LibraryExtension

TrafficPackage

UserFilter