Data Types
Last updated: 2025-12-07 00:27:12
Instance
Describes official cloud disk instance information.
Used by actions: DescribeOfficialInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| Domain | String | Dedicated domain name. if the instance has no dedicated domain name, this attribute is null. Note: This field may return null, indicating that no valid values can be obtained. |
| EffectiveTime | Timestamp ISO8601 | Effective time. |
| ExpireTime | Timestamp ISO8601 | Expiration time. if the instance is pay-as-you-go or permanently valid, this attribute is null. Note: This field may return null, indicating that no valid values can be obtained. |
| UserLimit | Integer | Number of users. if the instance uses pay-as-you-go billing or has unlimited users, this attribute is null. Note: This field may return null, indicating that no valid values can be obtained. |
| StorageLimit | String | Storage capacity in Bytes. this field is of String type due to precision limitations of numeric types. this property is null for pay-as-you-go instances or instances with unlimited storage capacity. Note: This field may return null, indicating that no valid values can be obtained. |
| StorageLimitGB | Integer | Storage capacity in GB. if the instance uses pay-as-you-go billing or has unlimited storage capacity, this attribute is null. Note: This field may return null, indicating that no valid values can be obtained. |
| Isolated | Boolean | Is expired isolation. |
| AutoRenew | Integer | Renewal flag. 0: manual renewal; 1: automatic renewal; 2: non-renewal upon expiration. |
| SuperAdminAccount | String | Specifies the super administrator account. if no selection query is made for the instance-bound super administrator account or the current instance is not bound to a super administrator account, this attribute is null. Note: This field may return null, indicating that no valid values can be obtained. |
| Bucket | String | In selected bucket mode, shows bucket usage. |
| LogBucket | String | Specifies the log bucket usage in selected mode. Note: This field may return null, indicating that no valid values can be obtained. |
Library
PaaS service media library information.
Used by actions: DescribeLibraries.
| Name | Type | Description |
|---|---|---|
| LibraryId | String | Media library ID. |
| Name | String | Specifies the friendly name of the media library. |
| Remark | String | Remarks. |
| BucketName | String | Specifies the COS storage bucket bound to the media library. |
| BucketRegion | String | Specifies the region where the COS bucket bound to the media library is located. |
| AccessDomain | String | Specifies the access domain of the business API for the media library. |
| CreationTime | Timestamp ISO8601 | Creation time of the media library. |
| LibraryExtension | LibraryExtension | Media library configuration item. |
| Size | String | Media library amount in Bytes. since the number type has precision limitations, this field is a String type. |
| DirNum | String | Number of media library directories. since the String type is used due to precision limitations of the number type, this field is of String type. |
| FileNum | String | Number of files in the media library. since the String type is used due to precision limitations of the number type, this field is of String type. |
LibraryExtension
Media library configuration item.
Used by actions: CreateLibrary, DescribeLibraries, ModifyLibrary.
| Name | Type | Required | Description |
|---|---|---|---|
| IsFileLibrary | Boolean | No | Specifies whether it is a file type media library that can store any type of file (true) or a media type media library that can only store images and playable video types (false). defaults to false. cannot be modified once created. |
| IsMultiSpace | Boolean | No | true indicates a multi-tenant space media library, allowing the creation of multiple tenant spaces. false indicates a single-tenant space media library, where tenant spaces cannot be created and only the default single tenant space can be used. defaults to false. cannot be modified after the media library is created. |
| CosStorageClass | String | No | Specifies the storage type for files saved to cloud object storage. valid values: STANDARD, STANDARD_IA, INTELLIGENT_TIERING, MAZ_STANDARD, MAZ_STANDARD_IA, and MAZ_INTELLIGENT_TIERING. defaults to STANDARD. when using a multi-AZ bucket, MAZ_ prefixed storage types for multi-AZ are automatically used, otherwise non-MAZ_ prefixed storage types for non-multi-AZ are used. when specifying INTELLIGENT TIERING storage INTELLIGENT_TIERING or MAZ_INTELLIGENT_TIERING, the bucket must have INTELLIGENT TIERING storage enabled beforehand, otherwise failure will be returned. cannot be modified after the media library is created. |
| UseRecycleBin | Boolean | No | Specifies whether the recycle bin feature is enabled. defaults to false. |
| AutoRemoveRecycledDays | Integer | No | Specifies the number of days to automatically delete items in the recycle bin when enabled, must not exceed 1095 (3 years). a value of 0 indicates no automatic deletion, defaults to 0. this property is null when the recycle bin is not enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| EnableSearch | Boolean | No | Whether to enable the file path search feature. is false by default. |
| DenyOnQuotaLessThanUsage | Boolean | No | Specifies whether to deny the configuration request when setting the space quota for a media library or tenant and the quota is less than the used storage capacity. is false by default. |
| EnableFileHistory | Boolean | No | Specifies whether the earlier version is enabled. defaults to false. |
| FileHistoryCount | Integer | No | Specifies the maximum number of historical versions to retain for a single file when versioning is enabled, with a value range of 1 to 999. this property may be null when versioning is not enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| FileHistoryExpireDay | Integer | No | Specifies the maximum days to retain earlier versions when versioning is enabled, with a value range of 0 to 999. when set to 0, it represents permanent retention. this property may be null when versioning is not enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| MaxDirFileNameLength | Integer | No | The maximum length of a directory or file name must not exceed 255, with a default value of 255. modifying this parameter will not affect existing directories or file names. if the value of this field is decreased, the length of existing directories or file names exceeding the target value does not change. |
| IsPublicRead | Boolean | No | Whether public read is enabled. once enabled, read operations require no access token. it is false by default. this property is supported only in single-tenant space media libraries. otherwise, it is null. Note: This field may return null, indicating that no valid values can be obtained. |
| IsMultiAlbum | Boolean | No | Specifies whether the multi-album feature is enabled for the media type media library. once enabled, first-level directories (albums) can be created, and media files can only be saved in these albums. unless enabled, albums cannot be created, and media files can only be saved in the root directory. defaults to false. this property is only supported for single-tenant space media type media libraries, otherwise it is null. cannot be modified after the media library is created. Note: This field may return null, indicating that no valid values can be obtained. |
| AllowPhoto | Boolean | No | Specifies whether the media library of the media type allows image uploads, set to true by default. this property is supported only for the media library of the media type in a single tenant space, otherwise it is null. Note: This field may return null, indicating that no valid values can be obtained. |
| AllowPhotoExtName | Array of String | No | Specifies the allowed extensions when the media type media library allows photo uploads. empty array by default. at this point, it will automatically determine based on the MIME type corresponding to the file extension. this property is supported only for single-tenant space media type media libraries. otherwise, the property is null. Note: This field may return null, indicating that no valid values can be obtained. |
| AllowVideo | Boolean | No | Media type media library specifies whether video upload is allowed, set to true by default. this property is supported only in single tenant space media type media library, otherwise the property is null. Note: This field may return null, indicating that no valid values can be obtained. |
| AllowVideoExtName | Array of String | No | Specifies the allowed extensions when the media type media library permits video uploads. the default is an empty array, at which point it will automatically determine based on the MIME type corresponding to the file extension. this property is supported only for single-tenant space media type media libraries, otherwise it is null. Note: This field may return null, indicating that no valid values can be obtained. |
| AllowFileExtName | Array of String | No | Specifies the file extensions allowed in the file type media library, empty by default. at this point, all types of files are upload allowed. this property is supported only for the file type media library in a single tenant space, otherwise it is null. Note: This field may return null, indicating that no valid values can be obtained. |
| RecognizeSensitiveContent | Boolean | No | Specifies whether to perform sensitive content identification during image upload. the value is false by default. this property is supported only in the single-tenant space media library, otherwise it is null. Note: This field may return null, indicating that no valid values can be obtained. |
TrafficPackage
Traffic package information.
Used by actions: DescribeTrafficPackages.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Specifies the instance ID offset by the traffic package. |
| Domain | String | Dedicated domain name. if the instance has no dedicated domain name, this attribute is null. Note: This field may return null, indicating that no valid values can be obtained. |
| Type | Integer | Source type of the traffic package. valid values: 0 (purchase), 1 (complimentary). |
| Size | String | Total traffic in Bytes. since the number type has precision limitations, this field is a String type. |
| SizeGB | Integer | Total traffic in GB. |
| Remain | String | Remaining traffic in Bytes. this field is of String type due to precision limitations of numeric data types. |
| Used | String | Used traffic in Bytes. since the number type has precision limitations, this field is a String type. |
| UsedPercentage | String | Usage percentage. since the String type is used due to precision limitations of the number type, this field is of String type. |
| EffectiveTime | Timestamp ISO8601 | Effective time, the order time of the traffic package. |
| ExpireTime | Timestamp ISO8601 | Expiration time, which is the expiration time of the offset instance. if the traffic package offsets a pay-as-you-go or permanently valid instance, this attribute is null. Note: This field may return null, indicating that no valid values can be obtained. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback