ucloud-sdk-python3 0.11.81__py3-none-any.whl

ucloud/services/ufile/schemas/apis.py

@@ -0,0 +1,542 @@
+""" Code is generated by ucloud-model, DO NOT EDIT IT. """
+
+from ucloud.core.typesystem import schema, fields
+from ucloud.services.ufile.schemas import models
+
+""" UFile API Schema
+"""
+
+
+"""
+API: CreateBucket
+
+创建Bucket
+"""
+
+
+class CreateBucketRequestSchema(schema.RequestSchema):
+    """CreateBucket - 创建Bucket"""
+
+    fields = {
+        "BucketName": fields.Str(required=True, dump_to="BucketName"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Type": fields.Str(required=False, dump_to="Type"),
+    }
+
+
+class CreateBucketResponseSchema(schema.ResponseSchema):
+    """CreateBucket - 创建Bucket"""
+
+    fields = {
+        "BucketId": fields.Str(required=False, load_from="BucketId"),
+        "BucketName": fields.Str(required=False, load_from="BucketName"),
+    }
+
+
+"""
+API: CreateUFileLifeCycle
+
+创建生命周期管理
+"""
+
+
+class CreateUFileLifeCycleRequestSchema(schema.RequestSchema):
+    """CreateUFileLifeCycle - 创建生命周期管理"""
+
+    fields = {
+        "ArchivalDays": fields.Int(required=False, dump_to="ArchivalDays"),
+        "BucketName": fields.Str(required=True, dump_to="BucketName"),
+        "Days": fields.Int(required=False, dump_to="Days"),
+        "IADays": fields.Int(required=False, dump_to="IADays"),
+        "LifeCycleName": fields.Str(required=True, dump_to="LifeCycleName"),
+        "Prefix": fields.Str(required=True, dump_to="Prefix"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=False, dump_to="Region"),
+        "Status": fields.Str(required=True, dump_to="Status"),
+    }
+
+
+class CreateUFileLifeCycleResponseSchema(schema.ResponseSchema):
+    """CreateUFileLifeCycle - 创建生命周期管理"""
+
+    fields = {
+        "LifeCycleId": fields.Str(required=True, load_from="LifeCycleId"),
+    }
+
+
+"""
+API: CreateUFileToken
+
+创建US3令牌
+"""
+
+
+class CreateUFileTokenRequestSchema(schema.RequestSchema):
+    """CreateUFileToken - 创建US3令牌"""
+
+    fields = {
+        "AllowedBuckets": fields.List(fields.Str()),
+        "AllowedOps": fields.List(fields.Str()),
+        "AllowedPrefixes": fields.List(fields.Str()),
+        "BlackIPList": fields.List(fields.Str()),
+        "ExpireTime": fields.Int(required=False, dump_to="ExpireTime"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=False, dump_to="Region"),
+        "TokenName": fields.Str(required=True, dump_to="TokenName"),
+        "WhiteIPList": fields.List(fields.Str()),
+    }
+
+
+class CreateUFileTokenResponseSchema(schema.ResponseSchema):
+    """CreateUFileToken - 创建US3令牌"""
+
+    fields = {
+        "TokenId": fields.Str(required=False, load_from="TokenId"),
+        "UFileTokenSet": models.UFileTokenSetSchema(),
+    }
+
+
+"""
+API: DeleteBucket
+
+删除Bucket
+"""
+
+
+class DeleteBucketRequestSchema(schema.RequestSchema):
+    """DeleteBucket - 删除Bucket"""
+
+    fields = {
+        "BucketName": fields.Str(required=True, dump_to="BucketName"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+    }
+
+
+class DeleteBucketResponseSchema(schema.ResponseSchema):
+    """DeleteBucket - 删除Bucket"""
+
+    fields = {
+        "BucketId": fields.Str(required=False, load_from="BucketId"),
+        "BucketName": fields.Str(required=False, load_from="BucketName"),
+    }
+
+
+"""
+API: DeleteUFileLifeCycle
+
+删除生命周期管理
+"""
+
+
+class DeleteUFileLifeCycleRequestSchema(schema.RequestSchema):
+    """DeleteUFileLifeCycle - 删除生命周期管理"""
+
+    fields = {
+        "BucketName": fields.Str(required=True, dump_to="BucketName"),
+        "LifeCycleId": fields.Str(required=True, dump_to="LifeCycleId"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=False, dump_to="Region"),
+    }
+
+
+class DeleteUFileLifeCycleResponseSchema(schema.ResponseSchema):
+    """DeleteUFileLifeCycle - 删除生命周期管理"""
+
+    fields = {}
+
+
+"""
+API: DeleteUFileToken
+
+删除令牌
+"""
+
+
+class DeleteUFileTokenRequestSchema(schema.RequestSchema):
+    """DeleteUFileToken - 删除令牌"""
+
+    fields = {
+        "ProjectId": fields.Str(required=True, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "TokenId": fields.Str(required=True, dump_to="TokenId"),
+    }
+
+
+class DeleteUFileTokenResponseSchema(schema.ResponseSchema):
+    """DeleteUFileToken - 删除令牌"""
+
+    fields = {}
+
+
+"""
+API: DescribeBucket
+
+获取Bucket的描述信息
+"""
+
+
+class DescribeBucketRequestSchema(schema.RequestSchema):
+    """DescribeBucket - 获取Bucket的描述信息"""
+
+    fields = {
+        "BucketName": fields.Str(required=False, dump_to="BucketName"),
+        "Limit": fields.Int(required=False, dump_to="Limit"),
+        "Offset": fields.Int(required=False, dump_to="Offset"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=False, dump_to="Region"),
+    }
+
+
+class DescribeBucketResponseSchema(schema.ResponseSchema):
+    """DescribeBucket - 获取Bucket的描述信息"""
+
+    fields = {
+        "DataSet": fields.List(
+            models.UFileBucketSetSchema(), required=False, load_from="DataSet"
+        ),
+    }
+
+
+"""
+API: DescribeUFileLifeCycle
+
+获取生命周期信息
+"""
+
+
+class DescribeUFileLifeCycleRequestSchema(schema.RequestSchema):
+    """DescribeUFileLifeCycle - 获取生命周期信息"""
+
+    fields = {
+        "BucketName": fields.Str(required=True, dump_to="BucketName"),
+        "LifeCycleId": fields.Str(required=False, dump_to="LifeCycleId"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=False, dump_to="Region"),
+    }
+
+
+class DescribeUFileLifeCycleResponseSchema(schema.ResponseSchema):
+    """DescribeUFileLifeCycle - 获取生命周期信息"""
+
+    fields = {
+        "DateSet": fields.List(
+            models.LifeCycleItemSchema(), required=True, load_from="DateSet"
+        ),
+    }
+
+
+"""
+API: DescribeUFileToken
+
+获取令牌信息
+"""
+
+
+class DescribeUFileTokenRequestSchema(schema.RequestSchema):
+    """DescribeUFileToken - 获取令牌信息"""
+
+    fields = {
+        "Display": fields.Int(required=False, dump_to="Display"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=False, dump_to="Region"),
+        "TokenId": fields.Str(required=False, dump_to="TokenId"),
+        "TokenName": fields.Str(required=False, dump_to="TokenName"),
+    }
+
+
+class DescribeUFileTokenResponseSchema(schema.ResponseSchema):
+    """DescribeUFileToken - 获取令牌信息"""
+
+    fields = {
+        "DataSet": fields.List(
+            models.UFileTokenSetSchema(), required=True, load_from="DataSet"
+        ),
+    }
+
+
+"""
+API: GetUFileDailyReport
+
+查看日消费报表
+"""
+
+
+class GetUFileDailyReportRequestSchema(schema.RequestSchema):
+    """GetUFileDailyReport - 查看日消费报表"""
+
+    fields = {
+        "BucketName": fields.Str(required=False, dump_to="BucketName"),
+        "EndTime": fields.Int(required=True, dump_to="EndTime"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "StartTime": fields.Int(required=True, dump_to="StartTime"),
+    }
+
+
+class GetUFileDailyReportResponseSchema(schema.ResponseSchema):
+    """GetUFileDailyReport - 查看日消费报表"""
+
+    fields = {
+        "DataSet": fields.List(
+            models.UFileReportItemSchema(), required=True, load_from="DataSet"
+        ),
+    }
+
+
+"""
+API: GetUFileQuota
+
+查看配额状态
+"""
+
+
+class GetUFileQuotaRequestSchema(schema.RequestSchema):
+    """GetUFileQuota - 查看配额状态"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "QuotaType": fields.Str(required=True, dump_to="QuotaType"),
+    }
+
+
+class GetUFileQuotaResponseSchema(schema.ResponseSchema):
+    """GetUFileQuota - 查看配额状态"""
+
+    fields = {
+        "LeftQuota": fields.Float(required=False, load_from="LeftQuota"),
+    }
+
+
+"""
+API: GetUFileQuotaInfo
+
+获取配额信息
+"""
+
+
+class GetUFileQuotaInfoRequestSchema(schema.RequestSchema):
+    """GetUFileQuotaInfo - 获取配额信息"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "QuotaType": fields.List(fields.Str()),
+        "Region": fields.Str(required=True, dump_to="Region"),
+    }
+
+
+class GetUFileQuotaInfoResponseSchema(schema.ResponseSchema):
+    """GetUFileQuotaInfo - 获取配额信息"""
+
+    fields = {
+        "DataSet": fields.List(
+            models.UFileQuotaDataSetItemSchema(),
+            required=False,
+            load_from="DataSet",
+        ),
+    }
+
+
+"""
+API: GetUFileQuotaPrice
+
+根据US3的购买配额，查询需要支付的价格。
+"""
+
+
+class GetUFileQuotaPriceRequestSchema(schema.RequestSchema):
+    """GetUFileQuotaPrice - 根据US3的购买配额，查询需要支付的价格。"""
+
+    fields = {
+        "DownloadTraffic": fields.Int(
+            required=False, dump_to="DownloadTraffic"
+        ),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "RequestCount": fields.Int(required=False, dump_to="RequestCount"),
+        "StorageVolume": fields.Int(required=False, dump_to="StorageVolume"),
+    }
+
+
+class GetUFileQuotaPriceResponseSchema(schema.ResponseSchema):
+    """GetUFileQuotaPrice - 根据US3的购买配额，查询需要支付的价格。"""
+
+    fields = {
+        "Price": fields.Float(required=False, load_from="Price"),
+    }
+
+
+"""
+API: GetUFileReport
+
+查看配额使用报表
+"""
+
+
+class GetUFileReportRequestSchema(schema.RequestSchema):
+    """GetUFileReport - 查看配额使用报表"""
+
+    fields = {
+        "EndTime": fields.Int(required=True, dump_to="EndTime"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "StartTime": fields.Int(required=True, dump_to="StartTime"),
+    }
+
+
+class GetUFileReportResponseSchema(schema.ResponseSchema):
+    """GetUFileReport - 查看配额使用报表"""
+
+    fields = {
+        "DataSet": fields.List(
+            models.UFileReportSetSchema(), required=False, load_from="DataSet"
+        ),
+    }
+
+
+"""
+API: SetUFileReferer
+
+设置对象存储防盗链
+"""
+
+
+class SetUFileRefererRequestSchema(schema.RequestSchema):
+    """SetUFileReferer - 设置对象存储防盗链"""
+
+    fields = {
+        "BucketName": fields.Str(required=True, dump_to="BucketName"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "RefererAllowNull": fields.Bool(
+            required=False, dump_to="RefererAllowNull"
+        ),
+        "RefererStatus": fields.Str(required=True, dump_to="RefererStatus"),
+        "RefererType": fields.Int(required=False, dump_to="RefererType"),
+        "Referers": fields.List(fields.Str()),
+        "Region": fields.Str(required=False, dump_to="Region"),
+    }
+
+
+class SetUFileRefererResponseSchema(schema.ResponseSchema):
+    """SetUFileReferer - 设置对象存储防盗链"""
+
+    fields = {}
+
+
+"""
+API: UpdateBucket
+
+更改Bucket的属性
+"""
+
+
+class UpdateBucketRequestSchema(schema.RequestSchema):
+    """UpdateBucket - 更改Bucket的属性"""
+
+    fields = {
+        "BucketName": fields.Str(required=True, dump_to="BucketName"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Type": fields.Str(required=True, dump_to="Type"),
+    }
+
+
+class UpdateBucketResponseSchema(schema.ResponseSchema):
+    """UpdateBucket - 更改Bucket的属性"""
+
+    fields = {
+        "BucketId": fields.Str(required=False, load_from="BucketId"),
+        "BucketName": fields.Str(required=False, load_from="BucketName"),
+    }
+
+
+"""
+API: UpdateUFileLifeCycle
+
+更新生命周期管理
+"""
+
+
+class UpdateUFileLifeCycleRequestSchema(schema.RequestSchema):
+    """UpdateUFileLifeCycle - 更新生命周期管理"""
+
+    fields = {
+        "ArchivalDays": fields.Int(required=False, dump_to="ArchivalDays"),
+        "BucketName": fields.Str(required=True, dump_to="BucketName"),
+        "Days": fields.Int(required=False, dump_to="Days"),
+        "IADays": fields.Int(required=False, dump_to="IADays"),
+        "LifeCycleId": fields.Str(required=True, dump_to="LifeCycleId"),
+        "LifeCycleName": fields.Str(required=True, dump_to="LifeCycleName"),
+        "Prefix": fields.Str(required=True, dump_to="Prefix"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=False, dump_to="Region"),
+        "Status": fields.Str(required=True, dump_to="Status"),
+    }
+
+
+class UpdateUFileLifeCycleResponseSchema(schema.ResponseSchema):
+    """UpdateUFileLifeCycle - 更新生命周期管理"""
+
+    fields = {}
+
+
+"""
+API: UpdateUFileToken
+
+更新令牌的操作权限，可操作key的前缀，可操作bucket和令牌超时时间点
+"""
+
+
+class UpdateUFileTokenRequestSchema(schema.RequestSchema):
+    """UpdateUFileToken - 更新令牌的操作权限，可操作key的前缀，可操作bucket和令牌超时时间点"""
+
+    fields = {
+        "AllowedBuckets": fields.List(fields.Str()),
+        "AllowedOps": fields.List(fields.Str()),
+        "AllowedPrefixes": fields.List(fields.Str()),
+        "ExpireTime": fields.Int(required=False, dump_to="ExpireTime"),
+        "ProjectId": fields.Str(required=True, dump_to="ProjectId"),
+        "Region": fields.Str(required=False, dump_to="Region"),
+        "TokenId": fields.Str(required=True, dump_to="TokenId"),
+        "TokenName": fields.Str(required=False, dump_to="TokenName"),
+    }
+
+
+class UpdateUFileTokenResponseSchema(schema.ResponseSchema):
+    """UpdateUFileToken - 更新令牌的操作权限，可操作key的前缀，可操作bucket和令牌超时时间点"""
+
+    fields = {}
+
+
+"""
+API: UpdateUdsRule
+
+针对对象存储的文件，进行自动触发解压。
+"""
+
+
+class UpdateUdsRuleRequestSchema(schema.RequestSchema):
+    """UpdateUdsRule - 针对对象存储的文件，进行自动触发解压。"""
+
+    fields = {
+        "ContactGroupId": fields.Str(required=False, dump_to="ContactGroupId"),
+        "DstBucket": fields.Str(required=True, dump_to="DstBucket"),
+        "DstDirectory": fields.Str(required=True, dump_to="DstDirectory"),
+        "DstTokenId": fields.Str(required=True, dump_to="DstTokenId"),
+        "Events": fields.List(fields.Str()),
+        "KeepUS3Name": fields.Bool(required=True, dump_to="KeepUS3Name"),
+        "NotificationTypes": fields.List(fields.Str()),
+        "Ops": fields.List(fields.Str()),
+        "Prefixes": fields.Str(required=True, dump_to="Prefixes"),
+        "RuleId": fields.Str(required=True, dump_to="RuleId"),
+        "RuleName": fields.Str(required=True, dump_to="RuleName"),
+        "SrcBucket": fields.Str(required=True, dump_to="SrcBucket"),
+        "SrcTokenId": fields.Str(required=True, dump_to="SrcTokenId"),
+    }
+
+
+class UpdateUdsRuleResponseSchema(schema.ResponseSchema):
+    """UpdateUdsRule - 针对对象存储的文件，进行自动触发解压。"""
+
+    fields = {
+        "Mesage": fields.Str(required=False, load_from="Mesage"),
+        "RuleId": fields.Str(required=True, load_from="RuleId"),
+    }

ucloud/services/ufile/schemas/models.py

@@ -0,0 +1,139 @@
+""" Code is generated by ucloud-model, DO NOT EDIT IT. """
+
+from ucloud.core.typesystem import schema, fields
+
+
+class UFileTokenSetSchema(schema.ResponseSchema):
+    """UFileTokenSet - ufile令牌集合"""
+
+    fields = {
+        "AllowedBuckets": fields.List(fields.Str()),
+        "AllowedOps": fields.List(fields.Str()),
+        "AllowedPrefixes": fields.List(fields.Str()),
+        "CreateTime": fields.Int(required=True, load_from="CreateTime"),
+        "ExpireTime": fields.Int(required=True, load_from="ExpireTime"),
+        "ModifyTime": fields.Int(required=True, load_from="ModifyTime"),
+        "PrivateKey": fields.Str(required=True, load_from="PrivateKey"),
+        "PublicKey": fields.Str(required=True, load_from="PublicKey"),
+        "Region": fields.Str(required=True, load_from="Region"),
+        "TokenId": fields.Str(required=True, load_from="TokenId"),
+        "TokenName": fields.Str(required=True, load_from="TokenName"),
+    }
+
+
+class UFileDomainSetSchema(schema.ResponseSchema):
+    """UFileDomainSet - DescribeBucket"""
+
+    fields = {
+        "Cdn": fields.List(fields.Str()),
+        "CustomCdn": fields.List(fields.Str()),
+        "CustomSrc": fields.List(fields.Str()),
+        "Src": fields.List(fields.Str()),
+    }
+
+
+class UFileBucketSetSchema(schema.ResponseSchema):
+    """UFileBucketSet - DescribeBucket"""
+
+    fields = {
+        "Biz": fields.Str(required=False, load_from="Biz"),
+        "BucketId": fields.Str(required=False, load_from="BucketId"),
+        "BucketName": fields.Str(required=False, load_from="BucketName"),
+        "CdnDomainId": fields.List(fields.Str()),
+        "CreateTime": fields.Int(required=False, load_from="CreateTime"),
+        "Domain": UFileDomainSetSchema(),
+        "HasUserDomain": fields.Int(required=False, load_from="HasUserDomain"),
+        "ModifyTime": fields.Int(required=False, load_from="ModifyTime"),
+        "Region": fields.Str(required=False, load_from="Region"),
+        "Tag": fields.Str(required=False, load_from="Tag"),
+        "Type": fields.Str(required=False, load_from="Type"),
+    }
+
+
+class LifeCycleItemSchema(schema.ResponseSchema):
+    """LifeCycleItem - 生命周期信息"""
+
+    fields = {
+        "ArchivalDays": fields.Int(required=False, load_from="ArchivalDays"),
+        "BucketName": fields.Str(required=False, load_from="BucketName"),
+        "Days": fields.Int(required=False, load_from="Days"),
+        "IADays": fields.Int(required=False, load_from="IADays"),
+        "LifeCycleId": fields.Str(required=False, load_from="LifeCycleId"),
+        "LifeCycleName": fields.Str(required=False, load_from="LifeCycleName"),
+        "Prefix": fields.Str(required=False, load_from="Prefix"),
+        "Status": fields.Str(required=False, load_from="Status"),
+    }
+
+
+class UFileTotalReportItemSchema(schema.ResponseSchema):
+    """UFileTotalReportItem - 总消费信息"""
+
+    fields = {
+        "ApiTimes": fields.Float(required=False, load_from="ApiTimes"),
+        "BusyFlow": fields.Float(required=False, load_from="BusyFlow"),
+        "CdnFlow": fields.Float(required=False, load_from="CdnFlow"),
+        "Flow": fields.Float(required=False, load_from="Flow"),
+        "IdleFlow": fields.Float(required=False, load_from="IdleFlow"),
+    }
+
+
+class UFileDailyReportItemSchema(schema.ResponseSchema):
+    """UFileDailyReportItem -"""
+
+    fields = {
+        "AcRestore": fields.Float(required=False, load_from="AcRestore"),
+        "AcStorage": fields.Float(required=False, load_from="AcStorage"),
+        "ApiTimes": fields.Float(required=False, load_from="ApiTimes"),
+        "BusyFlow": fields.Float(required=False, load_from="BusyFlow"),
+        "CdnFlow": fields.Float(required=False, load_from="CdnFlow"),
+        "Date": fields.Int(required=False, load_from="Date"),
+        "Flow": fields.Float(required=False, load_from="Flow"),
+        "IaGetSize": fields.Float(required=False, load_from="IaGetSize"),
+        "IaStorage": fields.Float(required=False, load_from="IaStorage"),
+        "IdleFlow": fields.Float(required=False, load_from="IdleFlow"),
+        "Storage": fields.Float(required=False, load_from="Storage"),
+    }
+
+
+class UFileReportItemSchema(schema.ResponseSchema):
+    """UFileReportItem -"""
+
+    fields = {
+        "Daily": fields.List(UFileDailyReportItemSchema()),
+        "Total": fields.List(UFileTotalReportItemSchema()),
+    }
+
+
+class UFileQuotaLeftSchema(schema.ResponseSchema):
+    """UFileQuotaLeft - 配额剩余量"""
+
+    fields = {
+        "Left": fields.Float(required=False, load_from="Left"),
+    }
+
+
+class UFileQuotaDataSetItemSchema(schema.ResponseSchema):
+    """UFileQuotaDataSetItem - 配额信息"""
+
+    fields = {
+        "DownloadFlow": UFileQuotaLeftSchema(),
+        "Owe": fields.Int(required=False, load_from="Owe"),
+        "Region": fields.Str(required=False, load_from="Region"),
+        "RequestCnt": UFileQuotaLeftSchema(),
+        "Storage": UFileQuotaLeftSchema(),
+    }
+
+
+class UFileReportSetSchema(schema.ResponseSchema):
+    """UFileReportSet - GetUFileReport"""
+
+    fields = {
+        "DownloadTraffic": fields.Float(
+            required=False, load_from="DownloadTraffic"
+        ),
+        "RequestCount": fields.Float(required=False, load_from="RequestCount"),
+        "StorageVolume": fields.Float(
+            required=False, load_from="StorageVolume"
+        ),
+        "Time": fields.Int(required=False, load_from="Time"),
+    }