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

ucloud/services/uphost/schemas/apis.py

@@ -0,0 +1,689 @@
+""" Code is generated by ucloud-model, DO NOT EDIT IT. """
+
+from ucloud.core.typesystem import schema, fields
+from ucloud.services.uphost.schemas import models
+
+""" UPHost API Schema
+"""
+
+
+"""
+API: CreatePHost
+
+指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。
+"""
+
+
+class CreatePHostParamDisksSchema(schema.RequestSchema):
+    """CreatePHostParamDisks -"""
+
+    fields = {
+        "CouponId": fields.Str(required=False, dump_to="CouponId"),
+        "IsBoot": fields.Str(required=False, dump_to="IsBoot"),
+        "Size": fields.Int(required=False, dump_to="Size"),
+        "Type": fields.Str(required=False, dump_to="Type"),
+    }
+
+
+class CreatePHostParamNetworkInterfaceEIPSchema(schema.RequestSchema):
+    """CreatePHostParamNetworkInterfaceEIP -"""
+
+    fields = {
+        "Bandwidth": fields.Str(required=False, dump_to="Bandwidth"),
+        "CouponId": fields.Str(required=False, dump_to="CouponId"),
+        "OperatorName": fields.Str(required=False, dump_to="OperatorName"),
+        "PayMode": fields.Str(required=False, dump_to="PayMode"),
+        "ShareBandwidthId": fields.Str(
+            required=False, dump_to="ShareBandwidthId"
+        ),
+    }
+
+
+class CreatePHostParamNetworkInterfaceSchema(schema.RequestSchema):
+    """CreatePHostParamNetworkInterface -"""
+
+    fields = {
+        "EIP": CreatePHostParamNetworkInterfaceEIPSchema(
+            required=False, dump_to="EIP"
+        ),
+    }
+
+
+class CreatePHostRequestSchema(schema.RequestSchema):
+    """CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。"""
+
+    fields = {
+        "ActivityId": fields.Int(required=False, dump_to="ActivityId"),
+        "CharacterName": fields.Str(required=False, dump_to="CharacterName"),
+        "ChargeType": fields.Str(required=False, dump_to="ChargeType"),
+        "Cluster": fields.Str(required=False, dump_to="Cluster"),
+        "Count": fields.Int(
+            required=False, dump_to="Count"
+        ),  # Deprecated, will be removed at 1.0
+        "CouponId": fields.Str(required=False, dump_to="CouponId"),
+        "Disks": fields.List(CreatePHostParamDisksSchema()),
+        "ImageId": fields.Str(required=True, dump_to="ImageId"),
+        "Name": fields.Str(required=False, dump_to="Name"),
+        "NetworkInterface": fields.List(
+            CreatePHostParamNetworkInterfaceSchema()
+        ),
+        "Password": fields.Str(required=True, dump_to="Password"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Quantity": fields.Str(required=False, dump_to="Quantity"),
+        "Raid": fields.Str(required=False, dump_to="Raid"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Remark": fields.Str(required=False, dump_to="Remark"),
+        "RuleId": fields.Int(required=False, dump_to="RuleId"),
+        "SecurityGroupId": fields.Str(
+            required=False, dump_to="SecurityGroupId"
+        ),
+        "SubnetId": fields.Str(required=False, dump_to="SubnetId"),
+        "Tag": fields.Str(required=False, dump_to="Tag"),
+        "Type": fields.Str(required=False, dump_to="Type"),
+        "VPCId": fields.Str(required=False, dump_to="VPCId"),
+        "VpcIp": fields.Str(required=False, dump_to="VpcIp"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class CreatePHostResponseSchema(schema.ResponseSchema):
+    """CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。"""
+
+    fields = {
+        "PHostId": fields.List(
+            fields.Str(), required=False, load_from="PHostId"
+        ),
+    }
+
+
+"""
+API: CreatePHostImage
+
+创建裸金属2.0用户自定义镜像
+"""
+
+
+class CreatePHostImageRequestSchema(schema.RequestSchema):
+    """CreatePHostImage - 创建裸金属2.0用户自定义镜像"""
+
+    fields = {
+        "ImageDescription": fields.Str(
+            required=False, dump_to="ImageDescription"
+        ),
+        "ImageName": fields.Str(required=True, dump_to="ImageName"),
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class CreatePHostImageResponseSchema(schema.ResponseSchema):
+    """CreatePHostImage - 创建裸金属2.0用户自定义镜像"""
+
+    fields = {
+        "ImageId": fields.Str(required=True, load_from="ImageId"),
+    }
+
+
+"""
+API: DescribeBaremetalMachineType
+
+获取裸金属机型的详细描述信息
+"""
+
+
+class DescribeBaremetalMachineTypeRequestSchema(schema.RequestSchema):
+    """DescribeBaremetalMachineType - 获取裸金属机型的详细描述信息"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Type": fields.Str(required=False, dump_to="Type"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class DescribeBaremetalMachineTypeResponseSchema(schema.ResponseSchema):
+    """DescribeBaremetalMachineType - 获取裸金属机型的详细描述信息"""
+
+    fields = {
+        "MachineTypes": fields.List(
+            models.PHostCloudMachineTypeSetSchema(),
+            required=False,
+            load_from="MachineTypes",
+        ),
+    }
+
+
+"""
+API: DescribePHost
+
+获取物理机详细信息
+"""
+
+
+class DescribePHostRequestSchema(schema.RequestSchema):
+    """DescribePHost - 获取物理机详细信息"""
+
+    fields = {
+        "Limit": fields.Int(required=False, dump_to="Limit"),
+        "Offset": fields.Int(required=False, dump_to="Offset"),
+        "PHostId": fields.List(fields.Str()),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "UDiskIdForAttachment": fields.Str(
+            required=False, dump_to="UDiskIdForAttachment"
+        ),
+        "VPCId": fields.Str(required=False, dump_to="VPCId"),
+        "Zone": fields.Str(required=False, dump_to="Zone"),
+    }
+
+
+class DescribePHostResponseSchema(schema.ResponseSchema):
+    """DescribePHost - 获取物理机详细信息"""
+
+    fields = {
+        "PHostSet": fields.List(
+            models.PHostSetSchema(), required=False, load_from="PHostSet"
+        ),
+        "TotalCount": fields.Int(required=False, load_from="TotalCount"),
+    }
+
+
+"""
+API: DescribePHostImage
+
+获取物理云主机镜像列表
+"""
+
+
+class DescribePHostImageRequestSchema(schema.RequestSchema):
+    """DescribePHostImage - 获取物理云主机镜像列表"""
+
+    fields = {
+        "ImageId": fields.List(fields.Str()),
+        "ImageType": fields.Str(required=False, dump_to="ImageType"),
+        "Limit": fields.Int(required=False, dump_to="Limit"),
+        "MachineType": fields.Str(required=False, dump_to="MachineType"),
+        "Offset": fields.Int(required=False, dump_to="Offset"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class DescribePHostImageResponseSchema(schema.ResponseSchema):
+    """DescribePHostImage - 获取物理云主机镜像列表"""
+
+    fields = {
+        "ImageSet": fields.List(
+            models.PHostImageSetSchema(), required=False, load_from="ImageSet"
+        ),
+        "TotalCount": fields.Int(required=False, load_from="TotalCount"),
+    }
+
+
+"""
+API: DescribePHostMachineType
+
+获取物理云机型的详细描述信息
+"""
+
+
+class DescribePHostMachineTypeRequestSchema(schema.RequestSchema):
+    """DescribePHostMachineType - 获取物理云机型的详细描述信息"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Type": fields.Str(required=False, dump_to="Type"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class DescribePHostMachineTypeResponseSchema(schema.ResponseSchema):
+    """DescribePHostMachineType - 获取物理云机型的详细描述信息"""
+
+    fields = {
+        "MachineTypes": fields.List(
+            models.PHostMachineTypeSetSchema(),
+            required=True,
+            load_from="MachineTypes",
+        ),
+    }
+
+
+"""
+API: DescribePHostTags
+
+获取物理机tag列表（业务组）
+"""
+
+
+class DescribePHostTagsRequestSchema(schema.RequestSchema):
+    """DescribePHostTags - 获取物理机tag列表（业务组）"""
+
+    fields = {
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=False, dump_to="Zone"),
+    }
+
+
+class DescribePHostTagsResponseSchema(schema.ResponseSchema):
+    """DescribePHostTags - 获取物理机tag列表（业务组）"""
+
+    fields = {
+        "TagSet": fields.List(
+            models.PHostTagSetSchema(), required=False, load_from="TagSet"
+        ),
+        "TotalCount": fields.Int(required=False, load_from="TotalCount"),
+    }
+
+
+"""
+API: GetPHostDiskUpgradePrice
+
+获取物理云裸金属挂载磁盘的升级价格
+"""
+
+
+class GetPHostDiskUpgradePriceRequestSchema(schema.RequestSchema):
+    """GetPHostDiskUpgradePrice - 获取物理云裸金属挂载磁盘的升级价格"""
+
+    fields = {
+        "DiskSpace": fields.Int(required=True, dump_to="DiskSpace"),
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "ReinstallTag": fields.Bool(required=False, dump_to="ReinstallTag"),
+        "UDiskId": fields.Str(required=False, dump_to="UDiskId"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class GetPHostDiskUpgradePriceResponseSchema(schema.ResponseSchema):
+    """GetPHostDiskUpgradePrice - 获取物理云裸金属挂载磁盘的升级价格"""
+
+    fields = {
+        "OriginalPrice": fields.Float(
+            required=False, load_from="OriginalPrice"
+        ),
+        "Price": fields.Float(required=True, load_from="Price"),
+    }
+
+
+"""
+API: GetPHostPrice
+
+获取物理机价格列表
+"""
+
+
+class GetPHostPriceParamDisksSchema(schema.RequestSchema):
+    """GetPHostPriceParamDisks -"""
+
+    fields = {
+        "IsBoot": fields.Str(required=False, dump_to="IsBoot"),
+        "Size": fields.Str(required=False, dump_to="Size"),
+        "Type": fields.Str(required=False, dump_to="Type"),
+    }
+
+
+class GetPHostPriceRequestSchema(schema.RequestSchema):
+    """GetPHostPrice - 获取物理机价格列表"""
+
+    fields = {
+        "ChargeType": fields.Str(required=True, dump_to="ChargeType"),
+        "Cluster": fields.Str(required=False, dump_to="Cluster"),
+        "Count": fields.Int(required=True, dump_to="Count"),
+        "Disks": fields.List(GetPHostPriceParamDisksSchema()),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Quantity": fields.Int(required=True, dump_to="Quantity"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Type": fields.Str(required=False, dump_to="Type"),
+        "Zone": fields.Str(required=False, dump_to="Zone"),
+    }
+
+
+class GetPHostPriceResponseSchema(schema.ResponseSchema):
+    """GetPHostPrice - 获取物理机价格列表"""
+
+    fields = {
+        "PriceSet": fields.List(
+            models.PHostPriceSetSchema(), required=False, load_from="PriceSet"
+        ),
+    }
+
+
+"""
+API: GetPhostDiskUpgradePrice
+
+获取物理云裸金属挂载磁盘的升级价格
+"""
+
+
+class GetPhostDiskUpgradePriceRequestSchema(schema.RequestSchema):
+    """GetPhostDiskUpgradePrice - 获取物理云裸金属挂载磁盘的升级价格"""
+
+    fields = {
+        "DiskId": fields.Str(required=True, dump_to="DiskId"),
+        "DiskSpace": fields.Int(required=True, dump_to="DiskSpace"),
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class GetPhostDiskUpgradePriceResponseSchema(schema.ResponseSchema):
+    """GetPhostDiskUpgradePrice - 获取物理云裸金属挂载磁盘的升级价格"""
+
+    fields = {
+        "Price": fields.Float(required=True, load_from="Price"),
+    }
+
+
+"""
+API: ModifyPHostImageInfo
+
+修改自定义镜像名称和备注
+"""
+
+
+class ModifyPHostImageInfoRequestSchema(schema.RequestSchema):
+    """ModifyPHostImageInfo - 修改自定义镜像名称和备注"""
+
+    fields = {
+        "ImageId": fields.Str(required=True, dump_to="ImageId"),
+        "Name": fields.Str(required=False, dump_to="Name"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Remark": fields.Str(required=False, dump_to="Remark"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class ModifyPHostImageInfoResponseSchema(schema.ResponseSchema):
+    """ModifyPHostImageInfo - 修改自定义镜像名称和备注"""
+
+    fields = {
+        "ImageId": fields.Str(required=False, load_from="ImageId"),
+    }
+
+
+"""
+API: ModifyPHostInfo
+
+更改物理机信息
+"""
+
+
+class ModifyPHostInfoRequestSchema(schema.RequestSchema):
+    """ModifyPHostInfo - 更改物理机信息"""
+
+    fields = {
+        "Name": fields.Str(required=False, dump_to="Name"),
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Remark": fields.Str(required=False, dump_to="Remark"),
+        "Tag": fields.Str(required=False, dump_to="Tag"),
+        "Zone": fields.Str(required=False, dump_to="Zone"),
+    }
+
+
+class ModifyPHostInfoResponseSchema(schema.ResponseSchema):
+    """ModifyPHostInfo - 更改物理机信息"""
+
+    fields = {
+        "PHostId": fields.Str(required=False, load_from="PHostId"),
+    }
+
+
+"""
+API: PoweroffPHost
+
+断电物理云主机
+"""
+
+
+class PoweroffPHostRequestSchema(schema.RequestSchema):
+    """PoweroffPHost - 断电物理云主机"""
+
+    fields = {
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=True, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=False, dump_to="Zone"),
+    }
+
+
+class PoweroffPHostResponseSchema(schema.ResponseSchema):
+    """PoweroffPHost - 断电物理云主机"""
+
+    fields = {
+        "PHostId": fields.Str(required=False, load_from="PHostId"),
+    }
+
+
+"""
+API: RebootPHost
+
+重启物理机
+"""
+
+
+class RebootPHostRequestSchema(schema.RequestSchema):
+    """RebootPHost - 重启物理机"""
+
+    fields = {
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=True, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=False, dump_to="Zone"),
+    }
+
+
+class RebootPHostResponseSchema(schema.ResponseSchema):
+    """RebootPHost - 重启物理机"""
+
+    fields = {
+        "PHostId": fields.Str(required=False, load_from="PHostId"),
+    }
+
+
+"""
+API: ReinstallPHost
+
+重装物理机操作系统
+"""
+
+
+class ReinstallPHostRequestSchema(schema.RequestSchema):
+    """ReinstallPHost - 重装物理机操作系统"""
+
+    fields = {
+        "BootDiskSpace": fields.Int(required=False, dump_to="BootDiskSpace"),
+        "ImageId": fields.Str(required=False, dump_to="ImageId"),
+        "Name": fields.Str(required=False, dump_to="Name"),
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "Password": fields.Str(required=True, dump_to="Password"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Raid": fields.Str(required=False, dump_to="Raid"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Remark": fields.Str(required=False, dump_to="Remark"),
+        "ReserveDisk": fields.Str(required=False, dump_to="ReserveDisk"),
+        "Tag": fields.Str(required=False, dump_to="Tag"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class ReinstallPHostResponseSchema(schema.ResponseSchema):
+    """ReinstallPHost - 重装物理机操作系统"""
+
+    fields = {
+        "PHostId": fields.Str(required=False, load_from="PHostId"),
+    }
+
+
+"""
+API: ResetPHostPassword
+
+重置裸金属实例的管理员密码
+"""
+
+
+class ResetPHostPasswordRequestSchema(schema.RequestSchema):
+    """ResetPHostPassword - 重置裸金属实例的管理员密码"""
+
+    fields = {
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "Password": fields.Str(required=True, dump_to="Password"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class ResetPHostPasswordResponseSchema(schema.ResponseSchema):
+    """ResetPHostPassword - 重置裸金属实例的管理员密码"""
+
+    fields = {
+        "PHostId": fields.Str(required=True, load_from="PHostId"),
+    }
+
+
+"""
+API: ResizePHostAttachedDisk
+
+修改裸金属物理云已经挂载的云盘容量大小
+"""
+
+
+class ResizePHostAttachedDiskRequestSchema(schema.RequestSchema):
+    """ResizePHostAttachedDisk - 修改裸金属物理云已经挂载的云盘容量大小"""
+
+    fields = {
+        "DiskSpace": fields.Int(required=False, dump_to="DiskSpace"),
+        "PHostId": fields.Str(required=False, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "UDiskId": fields.Str(required=False, dump_to="UDiskId"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class ResizePHostAttachedDiskResponseSchema(schema.ResponseSchema):
+    """ResizePHostAttachedDisk - 修改裸金属物理云已经挂载的云盘容量大小"""
+
+    fields = {
+        "UDiskId": fields.Str(required=False, load_from="UDiskId"),
+    }
+
+
+"""
+API: StartPHost
+
+启动物理机
+"""
+
+
+class StartPHostRequestSchema(schema.RequestSchema):
+    """StartPHost - 启动物理机"""
+
+    fields = {
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=True, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=False, dump_to="Zone"),
+    }
+
+
+class StartPHostResponseSchema(schema.ResponseSchema):
+    """StartPHost - 启动物理机"""
+
+    fields = {
+        "PHostId": fields.Str(required=False, load_from="PHostId"),
+    }
+
+
+"""
+API: StopPHost
+
+关闭物理机
+"""
+
+
+class StopPHostRequestSchema(schema.RequestSchema):
+    """StopPHost - 关闭物理机"""
+
+    fields = {
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=True, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=False, dump_to="Zone"),
+    }
+
+
+class StopPHostResponseSchema(schema.ResponseSchema):
+    """StopPHost - 关闭物理机"""
+
+    fields = {
+        "PHostId": fields.Str(required=True, load_from="PHostId"),
+    }
+
+
+"""
+API: TerminatePHost
+
+删除物理云主机
+"""
+
+
+class TerminatePHostRequestSchema(schema.RequestSchema):
+    """TerminatePHost - 删除物理云主机"""
+
+    fields = {
+        "PHostId": fields.Str(required=True, dump_to="PHostId"),
+        "ProjectId": fields.Str(required=True, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "ReleaseEIP": fields.Bool(required=False, dump_to="ReleaseEIP"),
+        "ReleaseUDisk": fields.Bool(required=False, dump_to="ReleaseUDisk"),
+        "Zone": fields.Str(required=False, dump_to="Zone"),
+    }
+
+
+class TerminatePHostResponseSchema(schema.ResponseSchema):
+    """TerminatePHost - 删除物理云主机"""
+
+    fields = {
+        "PHostId": fields.Str(required=False, load_from="PHostId"),
+    }
+
+
+"""
+API: TerminatePHostImage
+
+删除裸金属2.0用户自定义镜像
+"""
+
+
+class TerminatePHostImageRequestSchema(schema.RequestSchema):
+    """TerminatePHostImage - 删除裸金属2.0用户自定义镜像"""
+
+    fields = {
+        "ImageId": fields.Str(required=True, dump_to="ImageId"),
+        "ProjectId": fields.Str(required=False, dump_to="ProjectId"),
+        "Region": fields.Str(required=True, dump_to="Region"),
+        "Zone": fields.Str(required=True, dump_to="Zone"),
+    }
+
+
+class TerminatePHostImageResponseSchema(schema.ResponseSchema):
+    """TerminatePHostImage - 删除裸金属2.0用户自定义镜像"""
+
+    fields = {
+        "ImageId": fields.Str(required=True, load_from="ImageId"),
+    }