UCloud SDK Services¶

PathX¶

class ucloud.services.pathx.client.PathXClient(config, transport=None, middleware=None, logger=None)[source]¶

create_global_ssh_instance(req=None, **kwargs)[source]¶

CreateGlobalSSHInstance - 创建GlobalSSH实例

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口
Area (str) - (Required) 填写支持SSH访问IP的地区名称，如“洛杉矶”，“新加坡”，“香港”，“东京”，“华盛顿”，“法兰克福”。Area和AreaCode两者必填一个
AreaCode (str) - (Required) AreaCode, 区域航空港国际通用代码。Area和AreaCode两者必填一个
Port (int) - (Required) SSH端口，1-65535且不能使用80，443端口
TargetIP (str) - (Required) 被SSH访问的IP
ChargeType (str) - 支付方式，如按月、按年、按时
CouponId (str) - 使用代金券可冲抵部分费用
Quantity (int) - 购买数量
Remark (str) - 备注信息

Response

AcceleratingDomain (str) - 加速域名，访问该域名可就近接入
InstanceId (str) - 实例ID，资源唯一标识
Message (str) - 提示信息

delete_global_ssh_instance(req=None, **kwargs)[source]¶

DeleteGlobalSSHInstance - 删除GlobalSSH实例

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口
InstanceId (str) - (Required) 实例Id,资源的唯一标识

Response

Message (str) - 提示信息

describe_global_ssh_area(req=None, **kwargs)[source]¶

DescribeGlobalSSHArea - 获取GlobalSSH覆盖的地区列表用于控制显示哪些机房地域可以使用SSH特性

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口
Region (str) - (Config) 机房地域代号，如hk、 us-ca、 us-ws等。不填默认为空，返回所有支持地区。

Response

AreaSet (list) - 见 GlobalSSHArea 模型定义
Message (str) - 提示信息

Response Model

GlobalSSHArea

Area (str) - GlobalSSH覆盖的地区,如香港、东京、洛杉矶等
AreaCode (str) - 地区代号,以地区AirPort Code
RegionSet (list) - ucloud机房代号构成的数组，如[“hk”,”us-ca”]

describe_global_ssh_instance(req=None, **kwargs)[source]¶

DescribeGlobalSSHInstance - 获取GlobalSSH实例列表（传实例ID获取单个实例信息，不传获取项目下全部实例）

Request

ProjectId (str) - (Config) 项目ID，如org-xxxx。请参考 GetProjectList接口
InstanceId (str) - 实例ID，资源唯一标识

Response

InstanceSet (list) - 见 GlobalSSHInfo 模型定义

Response Model

GlobalSSHInfo

AcceleratingDomain (str) - 加速域名
Area (str) - 被SSH访问的IP所在地区
ChargeType (str) - 支付周期，如Month,Year等
CreateTime (int) - 资源创建时间戳
ExpireTime (int) - 资源过期时间戳
InstanceId (str) - 实例ID，资源唯一标识
Port (int) - SSH登陆端口
Remark (str) - 备注信息
TargetIP (str) - 被SSH访问的EIP

modify_global_ssh_port(req=None, **kwargs)[source]¶

ModifyGlobalSSHPort - 修改GlobalSSH端口

Request

ProjectId (str) - (Config) 项目ID，如org-xxxx。请参考 GetProjectList接口
InstanceId (str) - (Required) 实例ID,资源唯一标识
Port (int) - (Required) 调整后的SSH登陆端口

Response

Message (str) - 提示信息

modify_global_ssh_remark(req=None, **kwargs)[source]¶

ModifyGlobalSSHRemark - 修改GlobalSSH备注

Request

ProjectId (str) - (Config) 项目ID，如org-xxxx。请参考 GetProjectList接口
InstanceId (str) - (Required) 实例ID,资源唯一标识
Remark (str) - 备注信息，不填默认为空字符串

Response

Message (str) - 接口返回消息

StepFlow¶

class ucloud.services.stepflow.client.StepFlowClient(config, transport=None, middleware=None, logger=None)[source]¶

create_sf_workflow_from_template(req=None, **kwargs)[source]¶

CreateSFWorkflowFromTemplate - 导入工作流定义

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Namespace (str) - (Required) 需要创建的工作流namespace
Workflow (str) - (Required) 描述工作流定义的base64字符串
WorkflowName (str) - (Required) 需要创建的工作流名称

Response

Message (str) - 返回消息
Version (int) - 创建的工作流版本号

get_sf_workflow_template(req=None, **kwargs)[source]¶

GetSFWorkflowTemplate - 导出工作流定义

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
WorkflowId (str) - (Required) 被导出工作流的Id
WorkflowVersion (int) - 被导出工作流的版本号。取值范围：WorkflowVersion >= 1；默认会获取发布版本对应的workflow；超过最大版本会返回错误

Response

Message (str) - 返回消息
Version (int) - 导出工作流的版本号
Workflow (dict) - 见 WorkflowTemplate 模型定义
WorkflowId (str) - 导出工作流的Id

Response Model

Param

Name (str) - 参数名称
Type (str) - 参数类型
Value (str) - 参数值

ActivityTemplate

Input (dict) - Activity的输入
Name (str) - Activity的名字
Next (str) - 下一个Activity的名字
Output (list) - Activity的输出，详见Param
RetryTimes (str) - Activity的重试次数
Timeout (str) - Activity的超时时间
Type (str) - Activity的类型

WorkflowTemplate

Activites (list) - 见 ActivityTemplate 模型定义
Input (list) - 见 Param 模型定义
Output (list) - 见 Param 模型定义

UAccount¶

class ucloud.services.uaccount.client.UAccountClient(config, transport=None, middleware=None, logger=None)[source]¶

create_project(req=None, **kwargs)[source]¶

CreateProject - 创建项目

Request

ProjectName (str) - (Required) 项目名称

Response

ProjectId (str) - 所创建项目的Id

get_project_list(req=None, **kwargs)[source]¶

GetProjectList - 获取项目列表

Request

IsFinance (str) - 是否是财务账号

Response

ProjectCount (int) - 项目总数
ProjectSet (list) - 见 ProjectListInfo 模型定义

Response Model

ProjectListInfo

CreateTime (int) - 创建时间(Unix时间戳)
IsDefault (bool) - 是否为默认项目
MemberCount (int) - 项目下成员数量
ParentId (str) - 父项目ID
ParentName (str) - 父项目名称
ProjectId (str) - 项目ID
ProjectName (str) - 项目名称
ResourceCount (int) - 项目下资源数量

get_region(req=None, **kwargs)[source]¶

GetRegion - 获取用户在各数据中心的权限等信息

Request

Response

Regions (list) - 见 RegionInfo 模型定义

Response Model

RegionInfo

BitMaps (str) - 用户在此数据中心的权限位
IsDefault (bool) - 是否用户当前默认数据中心
Region (str) - 地域名字，如cn-bj
RegionId (int) - 数据中心ID
RegionName (str) - 数据中心名称
Zone (str) - 可用区名字，如cn-bj-01

get_user_info(req=None, **kwargs)[source]¶

GetUserInfo - 获取用户信息

Request

Response

DataSet (list) - 见 UserInfo 模型定义

Response Model

UserInfo

Admin (int) - 是否超级管理员 0:否 1:是
Administrator (str) - 管理员
AuthState (str) - 实名认证状态
City (str) - 城市
CompanyName (str) - 公司名称
Finance (int) - 是否有财务权限 0:否 1:是
IndustryType (int) - 所属行业
PhonePrefix (str) - 国际号码前缀
Province (str) - 省份
UserAddress (str) - 公司地址
UserEmail (str) - 用户邮箱
UserId (int) - 用户Id
UserName (str) - 称呼
UserPhone (str) - 用户手机
UserType (int) - 会员类型
UserVersion (int) - 是否子帐户(大于100为子帐户)

modify_project(req=None, **kwargs)[source]¶

ModifyProject - 修改项目

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ProjectName (str) - (Required) 新的项目名称

Response

terminate_project(req=None, **kwargs)[source]¶

TerminateProject - 删除项目

Request

ProjectId (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。

Response

UCDN¶

class ucloud.services.ucdn.client.UCDNClient(config, transport=None, middleware=None, logger=None)[source]¶

batch_describe_new_ucdn_domain(req=None, **kwargs)[source]¶

BatchDescribeNewUcdnDomain - 批量获取加速域名配置

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ChannelType (str) - 渠道ucdn、ufile、uvideo
DomainId (list) - 域名id，创建域名时生成的资源id，默认获取账号下的所有域名信息，n为自然数
Limit (int) - 返回数据长度，如果制定了Offset，则默认20，否则默认全部，非负整数
Offset (int) - 数据偏移量，默认0，非负整数

Response

Arrearage (list) - 标识欠费的数组，数组含有下列元素值， 1=国内流量有欠费 2=国外流量有欠费 3=国内带宽有欠费 4=国外带宽有欠费
ChargeType (int) - 当前计费方式，10=流量付费 20=带宽日峰值 30=按月后付费
DomainSet (list) - 见 DomainInfo 模型定义
LastChargeType (int) - 表示最后一次切换的计费方式，10=流量付费 20=带宽日峰值 30=按月后付费 40=未选择计费方式
MaxDomainNum (int) - 最大域名数量，默认20
TotalCount (int) - 满足条件的域名个数
Vip (str) - vip标示，yes-是 no-否

Response Model

CacheConf

CacheBehavior (int) - 是否缓存，1为缓存，0为不缓存。为0的情况下，CacheTTL和CacheUnit强制不生效
CacheTTL (int) - 缓存时间
CacheUnit (str) - 缓存时间的单位。sec（秒），min（分钟），hour（小时），day（天）
Description (str) - 缓存规则描述
FollowOriginRule (int) - 是否优先遵循源站头部缓存策略，0为不优先遵循源站，1为优先遵循源站缓存头部。默认为0
HttpCodePattern (str) - 状态码默认情况只缓存200类状态码，支持正则
IgnoreQueryString (int) - 是否忽略参数缓存（0为不忽略，1为忽略，默认为0）
PathPattern (str) - 路径模式，支持正则

AccessConf

IpBlacklist (str) - 多个ip用逗号隔开

DomainInfo

AccessConf (dict) - 见 AccessConf 模型定义
AreaCode (str) - 查询带宽区域 cn代表国内 abroad代表海外不填默认为全部区域
CacheConf (list) - 见 CacheConf 模型定义
CacheHost (str) - 缓存Host，不同的域名可以配置为同一个CacheHost来实现缓存共享，默认为加速域名
CdnProtocol (str) - 加速类型http,http|https
CdnType (str) - 加速域名的业务类型，web代表网站，stream代表视频，download代表下载。
CertName (str) - 证书名称
Cname (str) - cdn域名。创建加速域名生成的cdn域名，用于设置CNAME记录
CreateTime (int) - 域名创建的时间。格式：时间戳
Domain (str) - 域名，用户创建加速的域名
DomainId (str) - 域名id，创建域名时生成的id
HttpsStatusAbroad (str) - 国外https状态 enableing-开启中 fail-开启失败 enable-启用 disable-未启用
HttpsStatusCn (str) - 国内https状态 enableing-开启中 fail-开启失败 enable-启用 disable-未启用
NullRefer (bool) - ReferType为白名单时，NullRefer为false代表不允许NULL refer访问，为true代表允许Null refer访问
OriginHost (str) - 回源Http请求头部Host，默认是加速域名
OriginIp (list) - 源站ip即cdn服务器回源访问的ip地址。支持多个源站ip，多个源站ip，可表述为如：[1.1.1.1,2.2.2.2]
OriginPort (int) - 回源端口
OriginProtocol (str) - 源站协议http，http|https 默认http
ReferList (list) - Refer列表，支持正则表达式
ReferStatus (bool) - refer配置开关，true打开，false关闭
ReferType (int) - 0白名单，1黑名单
Status (str) - 创建的加速域名的当前的状态。check代表审核中，checkSuccess代表审核通过，checkFail代表审核失败，enable代表加速中，disable代表停止加速，delete代表删除加速 enableing代表正在开启加速，disableing代表正在停止加速中，deleteing代表删除中
Tag (str) - 业务组，默认为Default
TestUrl (str) - 测试url，用于域名创建加速时的测试
ValidTime (int) - 开始分配Cname时间。格式：时间戳

describe_new_ucdn_prefetch_cache_task(req=None, **kwargs)[source]¶

DescribeNewUcdnPrefetchCacheTask - 获取预取任务状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
BeginTime (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值
EndTime (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。
Limit (int) - 返回数据长度,默认全部，自然数
Offset (int) - 数据偏移量，默认为0，自然数
Status (str) - 需要获取的内容预热的状态，枚举值：success：成功；wait：等待处理；process：正在处理；failure：失败； unknow：未知，默认选择所有状态
TaskId (list) - 提交任务时返回的任务ID

Response

TaskList (list) - 见 TaskInfo 模型定义
TotalCount (int) - 预热任务的总数

Response Model

UrlProgressInfo

CreateTime (int) - 刷新任务创建的时间。格式为Unix Timestamp
FinishTime (int) - 任务完成时间。格式为Unix Timestamp
Progress (int) - 刷新进度，单位%
Status (str) - 刷新任务的当前状态，枚举值：success：成功；wait：排队中；process：处理中；failure：失败； unknow：未知
Url (str) - 刷新的单条url

TaskInfo

CreateTime (int) - 刷新任务创建的时间。格式为Unix Timestamp
Status (str) - 刷新任务的当前状态，枚举值：success：成功；wait：排队中；process：处理中；failure：失败； unknow：未知
TaskId (str) - 提交任务时返回的任务ID
Type (str) - file/dir 刷新任务会返回Type，预取任务没有
UrlLists (list) - 见 UrlProgressInfo 模型定义

describe_new_ucdn_refresh_cache_task(req=None, **kwargs)[source]¶

DescribeNewUcdnRefreshCacheTask - 获取域名刷新任务状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
BeginTime (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值
EndTime (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。
Limit (int) - 返回数据长度,默认全部，自然数
Offset (int) - 数据偏移量，默认为0，自然数
Status (str) - 需要获取的内容刷新的状态，枚举值：success：成功；wait：等待处理；process：正在处理；failure：失败； unknow：未知，默认选择所有状态
TaskId (list) - 提交任务时返回的任务ID

Response

TaskList (list) - 见 TaskInfo 模型定义
TotalCount (int) - 刷新任务的总数

Response Model

UrlProgressInfo

CreateTime (int) - 刷新任务创建的时间。格式为Unix Timestamp
FinishTime (int) - 任务完成时间。格式为Unix Timestamp
Progress (int) - 刷新进度，单位%
Status (str) - 刷新任务的当前状态，枚举值：success：成功；wait：排队中；process：处理中；failure：失败； unknow：未知
Url (str) - 刷新的单条url

TaskInfo

CreateTime (int) - 刷新任务创建的时间。格式为Unix Timestamp
Status (str) - 刷新任务的当前状态，枚举值：success：成功；wait：排队中；process：处理中；failure：失败； unknow：未知
TaskId (str) - 提交任务时返回的任务ID
Type (str) - file/dir 刷新任务会返回Type，预取任务没有
UrlLists (list) - 见 UrlProgressInfo 模型定义

get_new_ucdn_domain_bandwidth(req=None, **kwargs)[source]¶

GetNewUcdnDomainBandwidth - 获取域名带宽数据

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度）
Areacode (str) - 查询带宽区域 cn代表国内 abroad代表海外不填默认为全部区域
BeginTime (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名
EndTime (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。

Response

BandwidthList (list) - 见 BandwidthInfo 模型定义
Traffic (str) - 从起始时间到结束时间内的所使用的CDN总流量，单位GB

Response Model

BandwidthInfo

CdnBandwidth (str) - 返回值返回指定时间区间内CDN的带宽峰值，单位Mbps（如果请求参数Type为0，则Value是五分钟粒度的带宽值，如果Type为1，则Value是1小时的带宽峰值，如果Type为2，则Value是一天内的带宽峰值）
Time (int) - 带宽获取的时间点。格式：时间戳

get_new_ucdn_domain_hit_rate(req=None, **kwargs)[source]¶

GetNewUcdnDomainHitRate - 获取域名命中率

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度）
Areacode (str) - 查询带宽区域 cn代表国内 abroad代表海外，只支持国内
BeginTime (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名
EndTime (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。

Response

HitRateList (list) - 见 HitRateInfo 模型定义

Response Model

HitRateInfo

FlowHitRate (float) - 流量命中率，单位%
RequestHitRate (float) - 请求数命中率，单位%
Time (int) - 带宽获取的时间点。格式：时间戳

get_new_ucdn_domain_http_code(req=None, **kwargs)[source]¶

GetNewUcdnDomainHttpCode - 获取域名状态码监控

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度）
Areacode (str) - 查询带宽区域 cn代表国内 abroad代表海外，只支持国内
BeginTime (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名
EndTime (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。

Response

HttpCodeDetail (list) - 见 HttpCodeInfo 模型定义

Response Model

HttpCodeInfo

HttpFiveXX (int) - 5xx数量
HttpFourXX (int) - 4xx数量
HttpOneXX (int) - 1xx数量
HttpThreeXX (int) - 3xx数量
HttpTwoXX (int) - 2xx数量
Time (int) - 带宽获取的时间点。格式：时间戳

get_new_ucdn_domain_http_code_v2(req=None, **kwargs)[source]¶

GetNewUcdnDomainHttpCodeV2 - 获取域名详细状态码监控

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
BeginTime (int) - (Required) 查询的起始时间，格式为Unix Timestamp。
EndTime (int) - (Required) 查询的结束时间，格式为Unix Timestamp。
Type (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天粒度，3表示按照一分钟粒度）
Areacode (str) - 查询带宽区域 cn代表国内 abroad代表海外，只支持国内
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名

Response

HttpCodeV2Detail (list) - 见 HttpCodeV2Detail 模型定义

Response Model

HttpCodeV2Detail

Http100 (int) - http100数量
Http101 (int) - http101数量
Http102 (int) - http102数量
Http200 (int) - http200数量
Http201 (int) - http201数量
Http202 (int) - http202数量
Http203 (int) - http203数量
Http204 (int) - http204数量
Http205 (int) - http205数量
Http206 (int) - http206数量
Http207 (int) - http207数量
Http300 (int) - http300数量
Http301 (int) - http301数量
Http302 (int) - http302数量
Http303 (int) - http303数量
Http304 (int) - http304数量
Http305 (int) - http305数量
Http306 (int) - http306数量
Http307 (int) - http307数量
Http400 (int) - http400数量
Http401 (int) - http401数量
Http402 (int) - http402数量
Http403 (int) - http403数量
Http404 (int) - http404数量
Http405 (int) - http405数量
Http406 (int) - http406数量
Http407 (int) - http407数量
Http408 (int) - http408数量
Http409 (int) - http409数量
Http410 (int) - http410数量
Http411 (int) - http411数量
Http412 (int) - http412数量
Http413 (int) - http413数量
Http414 (int) - http414数量
Http415 (int) - http415数量
Http416 (int) - http416数量
Http417 (int) - http417数量
Http418 (int) - http418数量
Http421 (int) - http421数量
Http422 (int) - http422数量
Http423 (int) - http423数量
Http424 (int) - http424数量
Http425 (int) - http425数量
Http426 (int) - http426数量
Http449 (int) - http449数量
Http451 (int) - http451数量
Http500 (int) - http500数量
Http501 (int) - http501数量
Http502 (int) - http502数量
Http503 (int) - http503数量
Http504 (int) - http504数量
Http505 (int) - http505数量
Http506 (int) - http506数量
Http507 (int) - http507数量
Http509 (int) - http509数量
Http510 (int) - http510数量
Time (int) - 时间

get_new_ucdn_domain_request_num(req=None, **kwargs)[source]¶

GetNewUcdnDomainRequestNum - 获取域名请求数

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度）
Areacode (str) - 查询区域 cn代表国内 abroad代表海外，只支持国内
BeginTime (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名
EndTime (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。

Response

RequestList (list) - 见 RequestInfo 模型定义

Response Model

RequestInfo

CdnRequest (float) - 返回值返回指定时间区间内的cdn收到的请求次数之和
OriginRequest (float) - 返回值返回指定时间区间内的cdn回源的请求次数之和
Time (int) - 带宽获取的时间点。格式：时间戳

get_ucdn_domain_log(req=None, **kwargs)[source]¶

GetUcdnDomainLog - 获取加速域名原始日志

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
BeginTime (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。
DomainId (list) - 域名ID，创建加速域名时生成。默认全部域名
EndTime (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。
Type (int) - 查询粒度 0=default(没有粒度) 1=按小时 2=按天

Response

LogSet (list) - 见 LogSetList 模型定义

Response Model

LogSetInfo

AbroadLog (list) - 国外日志url列表
CnLog (list) - 国内日志url列表
Time (int) - 日志时间UnixTime

LogSetList

Domain (str) - 域名
Logs (list) - 见 LogSetInfo 模型定义

get_ucdn_domain_prefetch_enable(req=None, **kwargs)[source]¶

GetUcdnDomainPrefetchEnable - 获取域名预取开启状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
DomainId (str) - (Required) 域名ID，创建加速域名时生成。

Response

Enable (int) - 0表示该域名未开启预取，1表示该域名已开启预取

get_ucdn_domain_request_num_v2(req=None, **kwargs)[source]¶

GetUcdnDomainRequestNumV2 - 获取域名请求数

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
BeginTime (int) - (Required) 查询的起始时间，格式为Unix Timestamp
EndTime (int) - (Required) 查询的结束时间，格式为Unix Timestamp
Type (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度, 3=按1分钟）
Areacode (str) - 查询区域 cn代表国内 abroad代表海外，只支持国内
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名

Response

RequestList (list) - 见 RequestInfo 模型定义

Response Model

RequestInfo

CdnRequest (float) - 返回值返回指定时间区间内的cdn收到的请求次数之和
OriginRequest (float) - 返回值返回指定时间区间内的cdn回源的请求次数之和
Time (int) - 带宽获取的时间点。格式：时间戳

get_ucdn_domain_traffic(req=None, **kwargs)[source]¶

GetUcdnDomainTraffic - 获取加速域名流量使用信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Areacode (str) - 查询流量区域 cn代表国内 abroad代表海外，默认全部区域。
BeginTime (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。
DomainId (list) - 域名ID，创建加速域名时生成。默认全部域名
EndTime (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。

Response

TrafficSet (list) - 见 UcdnDomainTrafficSet 模型定义

Response Model

UcdnDomainTrafficSet

Time (int) - 流量获取的时间点，格式为Unix Timestamp
Value (float) - 查询每日流量总值，单位：GB

get_ucdn_pass_bandwidth(req=None, **kwargs)[source]¶

GetUcdnPassBandwidth - 获取回源带宽数据（cdn回客户源站部分）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度）
Areacode (str) - 查询带宽区域 cn代表国内 abroad代表海外，只支持国内
BeginTime (int) - 查询的起始时间，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值。如没有赋值，则返回缺少参数错误，如果没有EndTime，BeginTime也可以不赋值，EndTime默认当前时间，BeginTime 默认前一天的当前时间。
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名
EndTime (int) - 查询的结束时间，格式为Unix Timestamp。EndTime默认为当前时间，BeginTime默认为当前时间前一天时间。

Response

BandwidthDetail (list) - 见 BandwidthInfoDetail 模型定义

Response Model

BandwidthInfoDetail

Bandwidth (float) - 返回值带宽值数据。
Time (int) - 宽获取的时间点。格式：时间戳

get_ucdn_traffic(req=None, **kwargs)[source]¶

GetUcdnTraffic - 获取流量信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口

Response

TrafficSet (list) - 见 TrafficSet 模型定义

Response Model

TrafficSet

Areacode (str) - 购买流量的区域, cn: 国内; abroad: 国外
TrafficLeft (str) - Areacode区域内总剩余流量, 单位GB
TrafficTotal (str) - Areacode区域内总购买流量, 单位GB
TrafficUsed (str) - Areacode区域内总使用流量, 单位GB

prefetch_new_ucdn_domain_cache(req=None, **kwargs)[source]¶

PrefetchNewUcdnDomainCache - 提交预取任务

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
UrlList (list) - (Required) 预热URL列表，n从自然数0开始。UrlList.n字段必须以”http://域名/”开始。目录要以”/”结尾，如刷新目录a下所有文件，格式为：http://abc.ucloud.cn/a/；如刷新文件目录a下面img.png文件，格式为http://abc.ucloud.cn/a/img.png。请正确提交需要刷新的域名

Response

TaskId (str) - 本次提交url对应的任务id

refresh_new_ucdn_domain_cache(req=None, **kwargs)[source]¶

RefreshNewUcdnDomainCache - 刷新缓存

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (str) - (Required) 刷新类型，file代表文件刷新，dir 代表路径刷新
UrlList (list) - (Required) 刷新多个URL列表时，一次最多提交30个。必须以”http://域名/”开始。目录要以”/”结尾，如刷新目录a下所有文件，格式为：http://abc.ucloud.cn/a/；如刷新文件目录a下面img.png文件，格式为http://abc.ucloud.cn/a/img.png。请正确提交需要刷新的域名

Response

TaskId (str) - 本次提交url对应的任务id

switch_ucdn_charge_type(req=None, **kwargs)[source]¶

SwitchUcdnChargeType - 切换账号计费方式

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ChargeType (str) - (Required) 计费方式。traffic代表按流量包计费，bandwidth按带宽付费

Response

UDB¶

class ucloud.services.udb.client.UDBClient(config, transport=None, middleware=None, logger=None)[source]¶

backup_udb_instance(req=None, **kwargs)[source]¶

BackupUDBInstance - 备份UDB实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupName (str) - (Required) 备份名称
DBId (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取
BackupMethod (str) - 使用的备份方式。（快照备份即物理备份。注意只有SSD版本的mysql实例支持设置为snapshot）
Blacklist (str) - 备份黑名单列表，以 ; 分隔。注意：只有逻辑备份下备份黑名单才生效，快照备份备份黑名单下无效
ForceBackup (bool) - true表示逻辑备份时是使用 –force 参数，false表示不使用 –force 参数。物理备份此参数无效。
UseBlacklist (bool) - 是否使用黑名单备份，默认false
Zone (str) - 可用区。参见可用区列表

Response

backup_udb_instance_binlog(req=None, **kwargs)[source]¶

BackupUDBInstanceBinlog - 备份UDB指定时间段的binlog列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupFile (str) - (Required) 需要备份文件,可通过DescribeUDBInstanceBinlog获得如果要传入多个文件名，以空格键分割,用单引号包含.
DBId (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取
BackupName (str) - DB备份文件名称
Zone (str) - 可用区。参见可用区列表

Response

backup_udb_instance_error_log(req=None, **kwargs)[source]¶

BackupUDBInstanceErrorLog - 备份UDB指定时间段的errorlog

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupName (str) - (Required) 备份名称
DBId (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取
Zone (str) - 可用区。参见可用区列表

Response

backup_udb_instance_slow_log(req=None, **kwargs)[source]¶

BackupUDBInstanceSlowLog - 备份UDB指定时间段的slowlog分析结果

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupName (str) - (Required) 备份文件名称
BeginTime (int) - (Required) 过滤条件:起始时间(时间戳)
DBId (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取
EndTime (int) - (Required) 过滤条件:结束时间(时间戳)

Response

check_recover_udb_instance(req=None, **kwargs)[source]¶

CheckRecoverUDBInstance - 核查db是否可以使用回档功能

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SrcDBId (str) - (Required) 源实例的Id(只支持普通版DB不支持高可用)
Zone (str) - 可用区。参见可用区列表

Response

LastestTime (int) - 核查成功返回值为可以回档到的最近时刻,核查失败不返回

check_udb_instance_to_ha_allowance(req=None, **kwargs)[source]¶

CheckUDBInstanceToHAAllowance - 核查db是否可以升级为高可用

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取

Response

Allowance (str) - Yes ，No ，Yes即可以升级，No为不可以升级

clear_udb_log(req=None, **kwargs)[source]¶

ClearUDBLog - 清除UDB实例的log

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) DB实例的id,该值可以通过DescribeUDBInstance获取
LogType (int) - (Required) 日志类型，10-error（暂不支持）、20-slow（暂不支持）、30-binlog
BeforeTime (int) - 删除时间点(至少前一天)之前log，采用时间戳(秒)，默认当前时间点前一天
Zone (str) - 可用区。参见可用区列表

Response

create_udb_instance(req=None, **kwargs)[source]¶

CreateUDBInstance - 创建UDB实例（包括创建mysql master节点、mongodb primary/configsvr节点和从备份恢复实例）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AdminPassword (str) - (Required) 管理员密码
DBTypeId (str) - (Required) DB类型id，mysql/mongodb/postgesql按版本细分 1：mysql-5.1，2：mysql-5.5，3：percona-5.5，4：mysql-5.6，5：percona-5.6，6：mysql-5.7，7：percona-5.7，8：mariadb-10.0，9：mongodb-2.4，10：mongodb-2.6，11：mongodb-3.0，12：mongodb-3.2,13：postgresql-9.4，14：postgresql-9.6，14：postgresql-10.4
DiskSpace (int) - (Required) 磁盘空间(GB), 暂时支持20G - 3000G
MemoryLimit (int) - (Required) 内存限制(MB)，目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M
Name (str) - (Required) 实例名称，至少6位
ParamGroupId (int) - (Required) DB实例使用的配置参数组id
Port (int) - (Required) 端口号，mysql默认3306，mongodb默认27017，postgresql默认5432
Zone (str) - (Required) 可用区。参见可用区列表
AdminUser (str) - 管理员帐户名，默认root
BackupCount (int) - 备份策略，每周备份数量，默认7次
BackupDuration (int) - 备份策略，备份时间间隔，单位小时计，默认24小时
BackupId (int) - 备份id，如果指定，则表明从备份恢复实例
BackupTime (int) - 备份策略，备份开始时间，单位小时计，默认1点
BackupZone (str) - 跨可用区高可用备库所在可用区，参见可用区列表
CPU (int) - cpu核数
ChargeType (str) - Year， Month， Dynamic，Trial，默认: Month
ClusterRole (str) - 当DB类型(DBTypeId)为mongodb时，需要指定mongo的角色，可选值为configsrv (配置节点)，shardsrv (数据节点)
CouponId (str) - 使用的代金券id
DisableSemisync (bool) - 是否开启异步高可用，默认不填，可置为true
HAArch (str) - 高可用架构:1） haproxy（默认）: 当前仅支持mysql。2） sentinel: 基于vip和哨兵节点的架构，当前支持mysql和pg。
InstanceMode (str) - UDB实例模式类型, 可选值如下: “Normal”: 普通版UDB实例 “HA”: 高可用版UDB实例默认是”Normal”
InstanceType (str) - UDB数据库机型
Quantity (int) - 购买时长，默认值1
SSDType (str) - SSD类型，可选值为”SATA”、”PCI-E”，如果UseSSD为true ，则必选
SubnetId (str) - 子网ID
Tag (str) - 实例所在的业务组名称
UDBCId (str) - 专区ID信息（如果这个参数存在这说明是在专区中创建DB）
UseSSD (bool) - 是否使用SSD，默认为false。目前主要可用区、海外机房、新机房只提供SSD资源，非SSD资源不再提供。
VPCId (str) - VPC的ID

Response

DBId (str) - BD实例id

create_udb_instance_by_recovery(req=None, **kwargs)[source]¶

CreateUDBInstanceByRecovery - 创建db，将新创建的db恢复到指定db某个指定时间点

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称，至少6位
RecoveryTime (int) - (Required) 恢复到某个时间点的时间戳(UTC时间格式，默认单位秒)
SrcDBId (str) - (Required) 源实例的Id
ChargeType (str) - Year， Month， Dynamic，Trial，默认: Dynamic
CouponId (str) - 使用的代金券id
Quantity (int) - 购买时长，默认值1
SubnetId (str) - 子网ID
UDBCId (str) - 专区的Id
UseSSD (bool) - 指定是否是否使用SSD，默认使用主库的配置
VPCId (str) - VPC的ID
Zone (str) - 可用区。参见可用区列表

Response

DBId (str) - db实例id

create_udb_param_group(req=None, **kwargs)[source]¶

CreateUDBParamGroup - 从已有配置文件创建新配置文件

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBTypeId (str) - (Required) DB类型id，mysql/mongodb/postgesql按版本细分 1：mysql-5.1，2：mysql-5.5，3：percona-5.5，4：mysql-5.6，5：percona-5.6，6：mysql-5.7，7：percona-5.7，8：mariadb-10.0，9：mongodb-2.4，10：mongodb-2.6，11：mongodb-3.0，12：mongodb-3.2,13：postgresql-9.4，14：postgresql-9.6
Description (str) - (Required) 参数组描述
GroupName (str) - (Required) 新配置参数组名称
SrcGroupId (int) - (Required) 源参数组id
Zone (str) - (Required) 可用区。参见可用区列表
RegionFlag (bool) - 是否是地域级别的配置文件，默认是false

Response

GroupId (int) - 新配置参数组id

create_udb_replication_instance(req=None, **kwargs)[source]¶

CreateUDBReplicationInstance - 创建MongoDB的副本节点（包括仲裁）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称，至少6位
SrcId (str) - (Required) primary节点的DBId,该值可以通过DescribeUDBInstance获取
CouponId (str) - 使用的代金券id
IsArbiter (bool) - 是否是仲裁节点，默认false，仲裁节点按最小机型创建
Port (int) - 端口号，默认27017，取值范围3306至65535。
UseSSD (bool) - 是否使用SSD，默认不使用
Zone (str) - 可用区。参见可用区列表

Response

DBId (str) - 创建从节点的DBId

create_udb_route_instance(req=None, **kwargs)[source]¶

CreateUDBRouteInstance - 创建mongos实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ConfigsvrId (list) - (Required) 配置服务器的dbid，允许一个或者三个。
DBTypeId (str) - (Required) DB类型id，mongodb按版本细分有1：mongodb-2.4，2：mongodb-2.6,3：mongodb-3.0，4：mongodb-3.2
DiskSpace (int) - (Required) 磁盘空间(GB), 暂时支持20G - 500G
MemoryLimit (int) - (Required) 内存限制(MB)，目前支持以下几档 600M/1500M/3000M /6000M/15000M/30000M
Name (str) - (Required) 实例名称，至少6位
ParamGroupId (int) - (Required) DB实例使用的配置参数组id
Port (int) - (Required) 端口号，mongodb默认27017
ChargeType (str) - Year， Month， Dynamic，Trial，默认: Month
CouponId (str) - 使用的代金券id
Quantity (int) - 购买时长，默认值1
UseSSD (bool) - 是否使用SSD，默认为false
Zone (str) - 可用区。参见可用区列表

Response

DBId (str) - db实例id

create_udb_slave(req=None, **kwargs)[source]¶

CreateUDBSlave - 创建UDB实例的slave

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称，至少6位
SrcId (str) - (Required) master实例的DBId,该值可以通过DescribeUDBInstance获取
CouponId (str) - 使用的代金券id
DiskSpace (int) - 磁盘空间(GB), 暂时支持20G - 3000G（API支持，前端暂时只开放内存定制）
InstanceMode (str) - UDB实例部署模式，可选值如下：Normal: 普通单点实例HA: 高可用部署实例
InstanceType (str) - UDB实例类型：Normal和SATA_SSD
IsLock (bool) - 是否锁主库，默认为true
MemoryLimit (int) - 内存限制(MB)，目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M
Port (int) - 端口号，mysql默认3306
SSDType (str) - SSD类型，可选值为”SATA”、”PCI-E”，如果UseSSD为true ，则必选
UseSSD (bool) - 是否使用SSD，默认为false
Zone (str) - 可用区。参见可用区列表

Response

DBId (str) - 创建slave的DBId

delete_udb_backup(req=None, **kwargs)[source]¶

DeleteUDBBackup - 删除UDB实例备份

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupId (int) - (Required) 备份id，可通过DescribeUDBBackup获得
Zone (str) - (Required) 可用区。参见可用区列表
BackupZone (str) - 跨可用区高可用备库所在可用区，参见［可用区列表］

Response

delete_udb_instance(req=None, **kwargs)[source]¶

DeleteUDBInstance - 删除UDB实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) DB实例的id,该值可以通过DescribeUDBInstance获取
UDBCId (str) - 专区ID
Zone (str) - 可用区。参见可用区列表

Response

delete_udb_log_package(req=None, **kwargs)[source]¶

DeleteUDBLogPackage - 删除UDB日志包

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupId (int) - (Required) 日志包id，可通过DescribeUDBLogPackage获得
Zone (str) - (Required) 可用区。参见可用区列表
BackupZone (str) - 跨可用区高可用备库所在可用区

Response

delete_udb_param_group(req=None, **kwargs)[source]¶

DeleteUDBParamGroup - 删除配置参数组

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (int) - (Required) 参数组id,可通过DescribeUDBParamGroup获取
Zone (str) - (Required) 可用区。参见可用区列表
RegionFlag (bool) - 是否属于地域级别

Response

describe_udb_backup(req=None, **kwargs)[source]¶

DescribeUDBBackup - 列表UDB实例备份信息.Zone不填表示多可用区，填代表单可用区

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - (Required) 分页显示的条目数，列表操作则指定
Offset (int) - (Required) 分页显示的起始偏移，列表操作则指定
BackupId (int) - 如果填了BackupId, 那么只拉取这个备份的记录
BackupType (int) - 备份类型,取值为0或1，0表示自动，1表示手动
BeginTime (int) - 过滤条件:起始时间(Unix时间戳)
ClassType (str) - 如果未指定GroupId，则可选是否选取特定DB类型的配置(sql, nosql, postgresql, sqlserver)
DBId (str) - DB实例Id，如果指定，则只获取该db的备份信息该值可以通过DescribeUDBInstance获取
EndTime (int) - 过滤条件:结束时间(Unix时间戳)
Zone (str) - 可用区。参见可用区列表

Response

DataSet (list) - 见 UDBBackupSet 模型定义
TotalCount (int) - 满足条件备份总数，如果指定dbid，则是该db备份总数

Response Model

UDBBackupSet

BackupEndTime (int) - 备份完成时间(Unix时间戳)
BackupId (int) - 备份id
BackupName (str) - 备份名称
BackupSize (int) - 备份文件大小(字节)
BackupTime (int) - 备份时间(Unix时间戳)
BackupType (int) - 备份类型,取值为0或1,0表示自动，1表示手动
BackupZone (str) - 跨机房高可用备库所在可用区
DBId (str) - dbid
DBName (str) - 对应的db名称
ErrorInfo (str) - 备份错误信息
State (str) - 备份状态 Backuping // 备份中 Success // 备份成功 Failed // 备份失败 Expired // 备份过期
Zone (str) - 备份所在可用区

describe_udb_backup_blacklist(req=None, **kwargs)[source]¶

DescribeUDBBackupBlacklist - 获取UDB实例的备份黑名单

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取
Zone (str) - 可用区。参见可用区列表

Response

Blacklist (str) - DB的黑名单列表, db.%为指定库 dbname.tablename为指定表

describe_udb_binlog_backup_url(req=None, **kwargs)[source]¶

DescribeUDBBinlogBackupURL - 获取UDB的Binlog备份地址

Request

Region (str) - (Config) 地域。参见地域和可用区列表
BackupId (int) - (Required) DB实例binlog备份ID，可以从DescribeUDBLogPackage结果当中获得
DBId (str) - (Required) DB实例Id
Zone (str) - 可用区。参见可用区列表

Response

BackupPath (str) - DB实例备份文件的公网地址
InnerBackupPath (str) - DB实例备份文件的内网地址

describe_udb_instance(req=None, **kwargs)[source]¶

DescribeUDBInstance - 获取UDB实例信息，支持两类操作：（1）指定DBId用于获取该db的信息；（2）指定ClassType、Offset、Limit用于列表操作，查询某一个类型db。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ClassType (str) - DB种类，如果是列表操作，则需要指定,不区分大小写，其取值如下：mysql: SQL；mongo: NOSQL；postgresql: postgresql
DBId (str) - DB实例id，如果指定则获取单个db实例的描述，否则为列表操作。指定DBId时无需填写ClassType、Offset、Limit
IncludeSlaves (bool) - 当只获取这个特定DBId的信息时，如果有该选项，那么把这个DBId实例的所有从库信息一起拉取并返回
IsInUDBC (bool) - 是否查看专区里面DB
Limit (int) - 分页显示数量，列表操作时必填
Offset (int) - 分页显示起始偏移位置，列表操作时必填
UDBCId (str) - IsInUDBC为True,UDBCId为空，说明查看整个可用区的专区的db，如果UDBId不为空则只查看此专区下面的db
Zone (str) - 可用区，不填时默认全部可用区。参见可用区列表

Response

DataSet (list) - 见 UDBInstanceSet 模型定义
TotalCount (int) - 用户db组的数量，对于 mysql: 主从结对数量，没有slave，则只有master mongodb: 副本集数量

Response Model

UDBSlaveInstanceSet

AdminUser (str) - 管理员帐户名，默认root
BackupBeginTime (int) - 备份策略，不可修改，开始时间，单位小时计，默认3点
BackupBlacklist (str) - 备份策略，备份黑名单，mongodb则不适用
BackupCount (int) - 备份策略，不可修改，备份文件保留的数量，默认7次
BackupDate (str) - 备份日期标记位。共7位,每一位为一周中一天的备份情况 0表示关闭当天备份,1表示打开当天备份。最右边的一位为星期天的备份开关，其余从右到左依次为星期一到星期六的备份配置开关，每周必须至少设置两天备份。例如：1100000 表示打开星期六和星期五的自动备份功能
BackupDuration (int) - 备份策略，一天内备份时间间隔，单位小时，默认24小时
ChargeType (str) - Year， Month， Dynamic，Trial，默认: Dynamic
ClusterRole (str) - 当DB类型为mongodb时，返回该实例所在集群中的角色，包括：mongos、configsrv_sccc、configsrv_csrs、shardsrv_datanode、shardsrv_arbiter，其中congfigsrv分为sccc和csrs两种模式，shardsrv分为datanode和arbiter两种模式
CreateTime (int) - DB实例创建时间，采用UTC计时时间戳
DBId (str) - DB实例id
DBTypeId (str) - DB类型id，mysql/mongodb按版本细分各有一个id 目前id的取值范围为[1,7],数值对应的版本如下： 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6， 7：percona-5.6
DataFileSize (float) - DB实例数据文件大小，单位GB
DiskSpace (int) - 磁盘空间(GB), 默认根据配置机型
DiskUsedSize (float) - DB实例磁盘已使用空间，单位GB
ExpiredTime (int) - DB实例过期时间，采用UTC计时时间戳
InstanceMode (str) - UDB实例模式类型, 可选值如下: “Normal”: 普通版UDB实例;”HA”: 高可用版UDB实例
InstanceType (str) - UDB数据库机型
InstanceTypeId (int) - UDB数据库机型ID
LogFileSize (float) - DB实例日志文件大小，单位GB
MemoryLimit (int) - 内存限制(MB)，默认根据配置机型
ModifyTime (int) - DB实例修改时间，采用UTC计时时间戳
Name (str) - 实例名称，至少6位
ParamGroupId (int) - DB实例使用的配置参数组id
Port (int) - 端口号，mysql默认3306，mongodb默认27017
Role (str) - DB实例角色，mysql区分master/slave，mongodb多种角色
SSDType (str) - SSD类型，SATA/PCI-E
SrcDBId (str) - 对mysql的slave而言是master的DBId，对master则为空，对mongodb则是副本集id
State (str) - DB状态标记 Init：初始化中，Fail：安装失败，Starting：启动中，Running：运行，Shutdown：关闭中，Shutoff：已关闭，Delete：已删除，Upgrading：升级中，Promoting：提升为独库进行中，Recovering：恢复中，Recover fail：恢复失败
SubnetId (str) - 子网ID
SystemFileSize (float) - DB实例系统文件大小，单位GB
Tag (str) - 获取资源其他信息
UseSSD (bool) - 是否使用SSD
VPCId (str) - VPC的ID
VirtualIP (str) - DB实例虚ip
VirtualIPMac (str) - DB实例虚ip的mac地址
Zone (str) - 可用区

UDBInstanceSet

AdminUser (str) - 管理员帐户名，默认root
BackupBeginTime (int) - 备份策略，不可修改，开始时间，单位小时计，默认3点
BackupBlacklist (str) - 备份策略，备份黑名单，mongodb则不适用
BackupCount (int) - 备份策略，不可修改，备份文件保留的数量，默认7次
BackupDate (str) - 备份日期标记位。共7位,每一位为一周中一天的备份情况 0表示关闭当天备份,1表示打开当天备份。最右边的一位为星期天的备份开关，其余从右到左依次为星期一到星期六的备份配置开关，每周必须至少设置两天备份。例如：1100000 表示打开星期六和星期五的自动备份功能
BackupDuration (int) - 备份策略，一天内备份时间间隔，单位小时，默认24小时
BackupZone (str) - 跨可用区高可用备库所在可用区
ChargeType (str) - Year， Month， Dynamic，Trial，默认: Dynamic
CluserRole (str) - 当DB类型为mongodb时，返回该实例所在集群中的角色，包括：mongos、configsrv_sccc、configsrv_csrs、shardsrv_datanode、shardsrv_arbiter，其中congfigsrv分为sccc和csrs两种模式，shardsrv分为datanode和arbiter两种模式
CreateTime (int) - DB实例创建时间，采用UTC计时时间戳
DBId (str) - DB实例id
DBTypeId (str) - DB类型id，mysql/mongodb按版本细分各有一个id 目前id的取值范围为[1,7],数值对应的版本如下： 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6， 7：percona-5.6
DataFileSize (float) - DB实例数据文件大小，单位GB
DataSet (list) - 见 UDBSlaveInstanceSet 模型定义
DiskSpace (int) - 磁盘空间(GB), 默认根据配置机型
DiskUsedSize (float) - DB实例磁盘已使用空间，单位GB
ExpiredTime (int) - DB实例过期时间，采用UTC计时时间戳
InstanceMode (str) - UDB实例模式类型, 可选值如下: “Normal”：普通版UDB实例 “HA”: 高可用版UDB实例
InstanceType (str) - UDB数据库机型
InstanceTypeId (int) - UDB数据库机型ID
LogFileSize (float) - DB实例日志文件大小，单位GB
MemoryLimit (int) - 内存限制(MB)，默认根据配置机型
ModifyTime (int) - DB实例修改时间，采用UTC计时时间戳
Name (str) - 实例名称，至少6位
ParamGroupId (int) - DB实例使用的配置参数组id
Port (int) - 端口号，mysql默认3306，mongodb默认27017
Role (str) - DB实例角色，mysql区分master/slave，mongodb多种角色
SSDType (str) - SSD类型，SATA/PCI-E
SrcDBId (str) - 对mysql的slave而言是master的DBId，对master则为空，对mongodb则是副本集id
State (str) - DB状态标记 Init：初始化中，Fail：安装失败，Starting：启动中，Running：运行，Shutdown：关闭中，Shutoff：已关闭，Delete：已删除，Upgrading：升级中，Promoting：提升为独库进行中，Recovering：恢复中，Recover fail：恢复失败
SubnetId (str) - 子网ID
SystemFileSize (float) - DB实例系统文件大小，单位GB
Tag (str) - 获取资源其他信息
UseSSD (bool) - 是否使用SSD
VPCId (str) - VPC的ID
VirtualIP (str) - DB实例虚ip
VirtualIPMac (str) - DB实例虚ip的mac地址
Zone (str) - DB实例所在可用区

describe_udb_instance_backup_state(req=None, **kwargs)[source]¶

DescribeUDBInstanceBackupState - 获取UDB实例备份状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupId (int) - (Required) 备份记录ID
Zone (str) - (Required) 可用区。参见可用区列表
BackupZone (str) - 跨可用区高可用备库所在可用区，参见［可用区列表］

Response

BackupEndTime (int) -
BackupSize (int) -
State (str) - 备份状态 0 Backuping // 备份中 1 Success // 备份成功 2 Failed // 备份失败 3 Expired // 备份过期

describe_udb_instance_backup_url(req=None, **kwargs)[source]¶

DescribeUDBInstanceBackupURL - 获取UDB备份下载地址

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupId (int) - (Required) DB实例备份ID,该值可以通过DescribeUDBBackup获取
DBId (str) - (Required) DB实例Id,该值可通过DescribeUDBInstance获取
Zone (str) - 可用区。参见可用区列表

Response

BackupPath (str) - DB实例备份文件公网的地址
InnerBackupPath (str) - DB实例备份文件内网的地址

describe_udb_instance_binlog(req=None, **kwargs)[source]¶

DescribeUDBInstanceBinlog - 获取UDB指定时间段的binlog列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BeginTime (int) - (Required) 过滤条件:起始时间(时间戳)
DBId (str) - (Required) DB实例Id
EndTime (int) - (Required) 过滤条件:结束时间(时间戳)
Zone (str) - 可用区。参见可用区列表

Response

DataSet (list) - 见 UDBInstanceBinlogSet 模型定义

Response Model

UDBInstanceBinlogSet

BeginTime (int) - Binlog文件生成时间(时间戳)
EndTime (int) - Binlog文件结束时间(时间戳)
Name (str) - Binlog文件名
Size (int) - Binlog文件大小

describe_udb_instance_binlog_backup_state(req=None, **kwargs)[source]¶

DescribeUDBInstanceBinlogBackupState - 获取udb实例备份状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupId (int) - (Required) 备份记录ID
Zone (str) - (Required) 可用区。参见可用区列表
BackupZone (str) - 跨可用区高可用备库所在可用区

Response

BackupSize (int) - 备份文件大小(字节)
State (str) - 备份状态 0 Backuping // 备份中 1 Success // 备份成功 2 Failed // 备份失败 3 Expired // 备份过期

describe_udb_instance_price(req=None, **kwargs)[source]¶

DescribeUDBInstancePrice - 获取UDB实例价格信息

Request

Region (str) - (Config) 地域。参见地域和可用区列表
DBTypeId (str) - (Required) UDB实例的DB版本字符串
DiskSpace (int) - (Required) 磁盘空间(GB),暂时支持20(GB) - 3000(GB), 输入不带单位
MemoryLimit (int) - (Required) 内存限制(MB)，单位为MB.目前支持：1000-96000
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year，按年付费； Month，按月付费 Dynamic，按需付费（需开启权限) Trial，试用（需开启权限）默认为月付
Count (int) - 购买DB实例数量,最大数量为10台, 默认为1台
InstanceMode (str) - 实例的部署类型。可选值为：Normal: 普通单点实例，Slave: 从库实例,HA: 高可用部署实例，默认是Normal
Quantity (int) - DB购买多少个”计费时间单位”，默认值为1。比如：买2个月，Quantity就是2。如果计费单位是“按月”，并且Quantity为0，表示“购买到月底”
SSDType (str) - SSD类型，可选值为”SATA”、”PCI-E”，如果UseSSD为true ，则必填
UseSSD (str) - 是否使用SSD，只能填true或false，默认为false

Response

DataSet (list) - 见 UDBInstancePriceSet 模型定义

Response Model

UDBInstancePriceSet

ChargeType (str) - Year， Month， Dynamic，Trial
Price (int) - 价格，单位为分

describe_udb_instance_state(req=None, **kwargs)[source]¶

DescribeUDBInstanceState - 获取UDB实例状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取
Zone (str) - 可用区。参见可用区列表

Response

State (str) - DB状态标记 Init：初始化中；Fail：安装失败； Starting：启动中； Running ：运行；Shutdown：关闭中； Shutoff ：已关闭； Delete：已删除； Upgrading：升级中； Promoting：提升为独库进行中； Recovering：恢复中； Recover fail：恢复失败。

describe_udb_instance_upgrade_price(req=None, **kwargs)[source]¶

DescribeUDBInstanceUpgradePrice - 获取UDB实例升降级价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id
DiskSpace (int) - (Required) 磁盘空间(GB), 暂时支持20G - 500G
MemoryLimit (int) - (Required) 内存限制(MB)
SSDType (str) - SSD类型，可选值为”SATA”、”PCI-E”，如果UseSSD为true ，则必选
UseSSD (bool) - 是否使用SSD，默认为false
Zone (str) - 可用区。参见可用区列表

Response

Price (int) - 价格，单位为分

describe_udb_log_backup_url(req=None, **kwargs)[source]¶

DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址

Request

Region (str) - (Config) 地域。参见地域和可用区列表
BackupId (int) - (Required) DB实例备份ID
DBId (str) - (Required) DB实例Id
Zone (str) - 可用区。参见可用区列表

Response

BackupPath (str) - 备份外网URL
UsernetPath (str) - 备份用户网URL

describe_udb_log_package(req=None, **kwargs)[source]¶

DescribeUDBLogPackage - 列表UDB实例binlog或slowlog或errorlog备份信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - (Required) 分页显示的条目数，列表操作则指定
Offset (int) - (Required) 分页显示的起始偏移，列表操作则指定
BeginTime (int) - 过滤条件:起始时间(时间戳)
DBId (str) - DB实例Id，如果指定，则只获取该db的备份信息
EndTime (int) - 过滤条件:结束时间(时间戳)
Type (int) - 需要列出的备份文件类型，每种文件的值如下 2 : BINLOG_BACKUP 3 : SLOW_QUERY_BACKUP 4 : ERRORLOG_BACKUP
Types (list) - Types作为Type的补充，支持多值传入，可以获取多个类型的日志记录，如：Types.0=2&Types.1=3
Zone (str) - 可用区。参见可用区列表

Response

DataSet (list) - 见 LogPackageDataSet 模型定义
TotalCount (int) - 备份总数，如果指定dbid，则是该db备份总数

Response Model

LogPackageDataSet

BackupId (int) - 备份id
BackupName (str) - 备份名称
BackupSize (int) - 备份文件大小
BackupTime (int) - 备份时间
BackupType (int) - 备份类型，包括2-binlog备份，3-slowlog备份
BackupZone (str) - 跨可用区高可用备库所在可用区
DBId (str) - dbid
DBName (str) - 对应的db名称
State (str) - 备份状态 Backuping // 备份中 Success // 备份成功 Failed // 备份失败 Expired // 备份过期
Zone (str) - 所在可用区

describe_udb_param_group(req=None, **kwargs)[source]¶

DescribeUDBParamGroup - 获取参数组详细参数信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - (Required) 分页显示的条目数，列表操作则指定
Offset (int) - (Required) 分页显示的起始偏移，列表操作则指定
ClassType (str) - 如果未指定GroupId，则可选是否选取特定DB类型的配置(sql, nosql, postgresql, sqlserver)
GroupId (int) - 参数组id，如果指定则获取描述，否则是列表操作，需要指定Offset/Limit
IsInUDBC (bool) - 是否选取专区中配置
RegionFlag (bool) - 当请求没有填写Zone时，如果指定为true，表示只拉取跨可用区的相关配置文件，否则，拉取所有机房的配置文件（包括每个单可用区和跨可用区）
Zone (str) - 可用区。参见可用区列表

Response

DataSet (list) - 见 UDBParamGroupSet 模型定义
TotalCount (int) - 参数组总数，列表操作时才会有该参数

Response Model

UDBParamMemberSet

AllowedVal (str) - 允许的值(根据参数类型，用分隔符表示)
ApplyType (int) - 参数值应用类型,取值范围为{0,10,20}，各值代表意义为0-unknown、10-static、20-dynamic
FormatType (int) - 允许值的格式类型，取值范围为{0,10,20}，意义分别为PVFT_UNKOWN=0,PVFT_RANGE=10, PVFT_ENUM=20
Key (str) - 参数名称
Modifiable (bool) - 是否可更改，默认为false
Value (str) - 参数值
ValueType (int) - 参数值应用类型，取值范围为{0,10,20,30},各值代表意义为 0-unknown、10-int、20-string、 30-bool

UDBParamGroupSet

DBTypeId (str) - DB类型id，mysql/mongodb按版本细分各有一个id 目前id的取值范围为[1,7],数值对应的版本如下 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6 7：percona-5.6
Description (str) - 参数组描述
GroupId (int) - 参数组id
GroupName (str) - 参数组名称
Modifiable (bool) - 参数组是否可修改
ParamMember (list) - 见 UDBParamMemberSet 模型定义
RegionFlag (bool) -
Zone (str) -

describe_udb_type(req=None, **kwargs)[source]¶

DescribeUDBType - 获取UDB支持的类型信息

Request

Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - (Required) 可用区。参见可用区列表
BackupZone (str) - 跨可用区高可用DB的备库所在区域，仅当该可用区支持跨可用区高可用时填入。参见可用区列表
DBClusterType (str) - DB实例类型，如mysql，sqlserver，mongo，postgresql
DiskType (str) - 返回支持某种磁盘类型的DB类型。如果没传，则表示任何磁盘类型均可。
InstanceMode (str) - 返回支持某种实例类型的DB类型。如果没传，则表示任何实例类型均可。normal:单点,ha:高可用,sharded_cluster:分片集群

Response

Action (str) - 操作名称
DataSet (list) - 见 UDBTypeSet 模型定义
RetCode (int) - 返回码

Response Model

UDBTypeSet

DBTypeId (str) - DB类型id，mysql/mongodb按版本细分各有一个id, 目前id的取值范围为[1,7],数值对应的版本如下： 1：mysql-5.5，2：mysql-5.1，3：percona-5.5 4：mongodb-2.4，5：mongodb-2.6，6：mysql-5.6， 7：percona-5.6

edit_udb_backup_blacklist(req=None, **kwargs)[source]¶

EditUDBBackupBlacklist - 编辑UDB实例的备份黑名单

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Blacklist (str) - (Required) 黑名单，规范示例,指定库mysql.%;test.%; 指定表city.address;
DBId (str) - (Required) DB实例Id,该值可以通过DescribeUDBInstance获取
Zone (str) - 可用区。参见可用区列表

Response

fetch_udb_instance_earliest_recover_time(req=None, **kwargs)[source]¶

FetchUDBInstanceEarliestRecoverTime - 获取UDB最早可回档的时间点

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) DB实例Id
Zone (str) - 可用区。参见可用区列表

Response

EarliestTime (int) - 获取最早可回档时间点

modify_udb_instance_name(req=None, **kwargs)[source]¶

ModifyUDBInstanceName - 重命名UDB实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取
Name (str) - (Required) 实例的新名字, 长度要求为6~63位
Zone (str) - 可用区。参见可用区列表

Response

modify_udb_instance_password(req=None, **kwargs)[source]¶

ModifyUDBInstancePassword - 修改DB实例的管理员密码

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的ID,该值可以通过DescribeUDBInstance获取
Password (str) - (Required) 实例的新密码
AccountName (str) - sqlserver帐号，仅在sqlserver的情况下填该参数
Zone (str) - 可用区。参见可用区列表

Response

promote_udb_instance_to_ha(req=None, **kwargs)[source]¶

PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本)

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取

Response

promote_udb_slave(req=None, **kwargs)[source]¶

PromoteUDBSlave - 从库提升为独立库

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取
IsForce (bool) - 是否强制(如果从库落后可能会禁止提升)，默认false 如果落后情况下，强制提升丢失数据
Zone (str) - 可用区。参见可用区列表

Response

resize_udb_instance(req=None, **kwargs)[source]¶

ResizeUDBInstance - 修改（升级和降级）UDB实例的配置，包括内存和磁盘的配置，对于内存升级无需关闭实例，其他场景需要事先关闭实例。两套参数可以配置升降机：1.配置UseSSD和SSDType 2.配置InstanceType，不需要配置InstanceMode。这两套第二套参数的优先级更高

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id
DiskSpace (int) - (Required) 磁盘空间(GB), 暂时支持20G-3000G
MemoryLimit (int) - (Required) 内存限制(MB)，目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/ 12000M/16000M/ 24000M/32000M/ 48000M/64000M/96000M。
CouponId (str) - 使用的代金券id
InstanceMode (str) - UDB实例模式类型, 可选值如下: “Normal”: 普通版UDB实例 “HA”: 高可用版UDB实例默认是”Normal”
InstanceType (str) - UDB数据库机型: “Normal”: “标准机型” , “SATA_SSD”: “SSD机型” , “PCIE_SSD”: “SSD高性能机型” , “Normal_Volume”: “标准大容量机型”, “SATA_SSD_Volume”: “SSD大容量机型” , “PCIE_SSD_Volume”: “SSD高性能大容量机型”
SSDType (str) - SSD类型，可选值为”SATA”、”PCI-E”，如果UseSSD为true ，则必选
StartAfterUpgrade (bool) - DB关闭状态下升降级，升降级后是否启动DB，默认为false
UDBCId (str) - 专区的ID，如果有值表示专区中的DB配置升降级
UseSSD (bool) - 是否使用SSD，默认为false
Zone (str) - 可用区。参见可用区列表

Response

restart_udb_instance(req=None, **kwargs)[source]¶

RestartUDBInstance - 重启UDB实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取
Zone (str) - 可用区。参见可用区列表

Response

start_udb_instance(req=None, **kwargs)[source]¶

StartUDBInstance - 启动UDB实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取
Zone (str) - 可用区。参见可用区列表

Response

stop_udb_instance(req=None, **kwargs)[source]¶

StopUDBInstance - 关闭UDB实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取
ForceToKill (bool) - 是否使用强制手段关闭DB，默认是false
Zone (str) - 可用区。参见可用区列表

Response

switch_udb_instance_to_ha(req=None, **kwargs)[source]¶

SwitchUDBInstanceToHA - 普通UDB切换为高可用，原db状态为WaitForSwitch时，调用该api

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 实例的Id,该值可以通过DescribeUDBInstance获取
ChargeType (str) - Year， Month， Dynamic，Trial，不填则按现在单点计费执行
Quantity (str) - 购买时长，需要和 ChargeType 搭配使用，否则使用单点计费策略的值
Tag (str) - 业务组

Response

DBId (str) - 切换后高可用db实例的Id

update_udb_instance_backup_strategy(req=None, **kwargs)[source]¶

UpdateUDBInstanceBackupStrategy - 修改UDB自动备份策略

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) 主节点的Id
BackupDate (str) - 备份时期标记位。共7位，每一位为一周中一天的备份情况，0表示关闭当天备份，1表示打开当天备份。最右边的一位为星期天的备份开关，其余从右到左依次为星期一到星期六的备份配置开关，每周必须至少设置两天备份。例如：1100000表示打开星期六和星期五的备份功能
BackupMethod (str) - 选择默认的备份方式，可选 snapshot 表示使用快照/物理备份，填 logic 表示使用逻辑备份。需要同时设置BackupDate字段。（注意现在只有SSD 版本的 MySQL实例支持物理备份）
BackupTime (int) - 备份的整点时间，范围[0,23]
ForceDump (bool) - 当导出某些数据遇到问题后，是否强制导出其他剩余数据默认是false需要同时设置BackupDate字段
Zone (str) - 可用区。参见可用区列表

Response

update_udb_instance_slave_backup_switch(req=None, **kwargs)[source]¶

UpdateUDBInstanceSlaveBackupSwitch - 开启或者关闭UDB从库备份

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupSwitch (int) - (Required) 从库的备份开关，范围[0,1],0表示从库备份功能关闭,1 表示从库备份开关打开。
MasterDBId (str) - (Required) 主库的Id
SlaveDBId (str) - 从库的Id,如果从库备份开关设定为打开，则必须赋值。
Zone (str) - 可用区。参见可用区列表

Response

update_udb_param_group(req=None, **kwargs)[source]¶

UpdateUDBParamGroup - 更新UDB配置参数项

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (int) - (Required) 配置参数组id，使用DescribeUDBParamGroup获得
Zone (str) - (Required) 可用区。参见可用区列表
Description (str) - 配置文件的描述，不传时认为不修改
Key (str) - 参数名称（与Value配合使用）
Name (str) - 配置文件的名字，不传时认为不修改名字，传了则不能为空
RegionFlag (bool) - 该配置文件是否是地域级别配置文件，默认是false
Value (str) - 参数值（与Key配合使用）

Response

upload_udb_param_group(req=None, **kwargs)[source]¶

UploadUDBParamGroup - 导入UDB配置

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Content (str) - (Required) 配置内容，导入的配置内容采用base64编码
DBTypeId (str) - (Required) DB类型id，DB类型id，mysql/mongodb/postgesql按版本细分 1：mysql-5.1，2：mysql-5.5，3：percona-5.5，4：mysql-5.6，5：percona-5.6，6：mysql-5.7，7：percona-5.7，8：mariadb-10.0，9：mongodb-2.4，10：mongodb-2.6，11：mongodb-3.0，12：mongodb-3.2,13：postgresql-9.4，14：postgresql-9.6
Description (str) - (Required) 参数组描述
GroupName (str) - (Required) 配置参数组名称
Zone (str) - (Required) 可用区。参见可用区列表
ParamGroupTypeId (int) - 配置文件子类型 0-未知, 1-Shardsvr-MMAPv1, 2-Shardsvr-WiredTiger, 3-Configsvr-MMAPv1, 4-Configsvr-WiredTiger, 5-Mongos
RegionFlag (bool) - 该配置文件是否是地域级别配置文件，默认是false

Response

GroupId (int) - 配置参数组id

UDPN¶

class ucloud.services.udpn.client.UDPNClient(config, transport=None, middleware=None, logger=None)[source]¶

allocate_udpn(req=None, **kwargs)[source]¶

AllocateUDPN - 分配一条 UDPN 专线

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Bandwidth (int) - (Required) 带宽
Peer1 (str) - (Required) 专线可用区1，支持地域：北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 洛杉矶：us-la，华盛顿：us-ws，东京：jpn-tky
Peer2 (str) - (Required) 专线可用区2，支持地域：北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 洛杉矶：us-la，华盛顿：us-ws，东京：jpn-tky
ChargeType (str) - 计费类型，枚举值为： Year，按年付费； Month，按月付费； Dynamic，按需付费
CouponId (str) - 代金劵
Quantity (int) - 计费时长，默认 1

Response

UDPNId (str) - 资源名称

describe_udpn(req=None, **kwargs)[source]¶

DescribeUDPN - 描述 UDPN

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 返回数据长度，默认为 20
Offset (int) - 列表起始位置偏移量，默认为 0
UDPNId (str) - 申请到的 UDPN 资源 ID。若为空，则查询该用户在机房所有的专线信息。非默认项目资源，需填写ProjectId

Response

DataSet (list) - 见 UDPNData 模型定义
TotalCount (int) - 查询到的总数量

Response Model

UDPNData

Bandwidth (int) - 带宽
ChargeType (str) - 计费类型
CreateTime (int) - unix 时间戳创建时间
ExpireTime (int) - unix 时间戳到期时间
Peer1 (str) - 可用区域 1
Peer2 (str) - 可用区域 2
UDPNId (str) - UDPN 资源短 ID

get_udpn_line_list(req=None, **kwargs)[source]¶

GetUDPNLineList - 获取当前支持的专线线路列表

Request

ProjectId (str) - (Config)
Region (str) - (Config) 地域。参见地域和可用区列表

Response

DataSet (list) - 见 UDPNLineSet 模型定义
TotalCount (int) - DataSet中的元素个数

Response Model

UDPNLineSet

BandwidthUpperLimit (int) - 线路带宽上限,单位 M
LocalRegion (str) - 支持UDPN的地域之一，北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 华盛顿：us-ws, 洛杉矶：us-la，东京：jpn-tky
RemoteRegion (str) - 支持UDPN的地域之一，北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 华盛顿：us-ws, 洛杉矶：us-la，东京：jpn-tky

get_udpn_price(req=None, **kwargs)[source]¶

GetUDPNPrice - 获取 UDPN 价格

Request

Region (str) - (Config) 地域。参见地域和可用区列表
Bandwidth (int) - (Required) 带宽信息
Peer1 (str) - (Required) 专线可用区1，支持地域：北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 洛杉矶：us-la，华盛顿：us-ws，东京：jpn-tky
Peer2 (str) - (Required) 专线可用区2，支持地域：北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 洛杉矶：us-la，华盛顿：us-ws，东京：jpn-tky
ChargeType (str) - 计费类型
Quantity (int) - 购买时长

Response

Price (float) - 专线价格
PurchaseValue (int) - 资源有效期 unix 时间戳

get_udpn_upgrade_price(req=None, **kwargs)[source]¶

GetUDPNUpgradePrice - 获取专线升级价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Bandwidth (int) - (Required) 带宽
UDPNId (str) - (Required) 专线带宽资源 Id

Response

Price (float) - 升级后的价格

modify_udpn_bandwidth(req=None, **kwargs)[source]¶

ModifyUDPNBandwidth - 修改带宽值

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Bandwidth (int) - (Required) 调整后专线带宽, 单位为Mbps，取值范围为大于等于2且小于等于1000([2-1000])的整数
UDPNId (str) - (Required) UDPN Id
CouponId (str) - 代金劵 ID

Response

release_udpn(req=None, **kwargs)[source]¶

ReleaseUDPN - 释放 UDPN

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDPNId (str) - (Required) UDPN 资源 Id

Response

UDisk¶

class ucloud.services.udisk.client.UDiskClient(config, transport=None, middleware=None, logger=None)[source]¶

attach_udisk(req=None, **kwargs)[source]¶

AttachUDisk - 将一个可用的UDisk挂载到某台主机上，当UDisk挂载成功后，还需要在主机内部进行文件系统操作

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDiskId (str) - (Required) 需要挂载的UDisk实例ID.
UHostId (str) - (Required) UHost实例ID
Zone (str) - (Required) 可用区。参见可用区列表
MultiAttach (str) - 是否允许多点挂载（Yes: 允许多点挂载， No: 不允许多点挂载，不填默认Yes ）

Response

UDiskId (str) - 挂载的UDisk实例ID
UHostId (str) - 挂载的UHost实例ID

clone_udisk(req=None, **kwargs)[source]¶

CloneUDisk - 从UDisk创建UDisk克隆

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称
SourceId (str) - (Required) 克隆父Disk的Id
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic，Postpay 默认: Dynamic
Comment (str) - Disk注释
CouponId (str) - 使用的代金券id
Quantity (int) - 购买时长默认: 1
UDataArkMode (str) - 方舟是否开启，”Yes”:开启，”No”:关闭；默认为”No”

Response

UDiskId (list) - 创建UDisk Id

clone_udisk_snapshot(req=None, **kwargs)[source]¶

CloneUDiskSnapshot - 从快照创建UDisk克隆

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称
Size (int) - (Required) 购买UDisk大小,单位:GB,范围[1~2000], 权限位控制可达8T,若需要请申请开通相关权限。
SourceId (str) - (Required) 克隆父Snapshot的Id
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic，Postpay 默认: Dynamic
Comment (str) - Disk注释
CouponId (str) - 使用的代金券id
Quantity (int) - 购买时长默认: 1
UDataArkMode (str) - 是否开启数据方舟默认:No

Response

UDiskId (list) - 创建UDisk Id

create_udisk(req=None, **kwargs)[source]¶

CreateUDisk - 创建UDisk磁盘

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称
Size (int) - (Required) 购买UDisk大小,单位:GB,普通盘: 范围[1~2000], 权限位控制可达8T,若需要请申请开通相关权限;SSD盘：范围[1~4000]。
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic, Postpay, Trial 默认: Dynamic
CmkId (str) - 加密需要的cmk id，UKmsMode为Yes时，必填
CouponId (str) - 使用的代金券id
DiskType (str) - UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），RSSDDataDisk（RSSD数据盘），默认值（DataDisk）
Quantity (int) - 购买时长默认: 1
Tag (str) - 业务组默认：Default
UDataArkMode (str) - 是否开启数据方舟
UKmsMode (str) - 是否加密。Yes：加密，No：不加密，默认值（No）

Response

UDiskId (list) - UDisk实例Id

create_udisk_snapshot(req=None, **kwargs)[source]¶

CreateUDiskSnapshot - 创建snapshot快照

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 快照名称
UDiskId (str) - (Required) 快照的UDisk的Id
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic 默认: Dynamic
Comment (str) - 快照描述
Quantity (int) - 购买时长默认: 1

Response

SnapshotId (list) - 快照Id

delete_udisk(req=None, **kwargs)[source]¶

DeleteUDisk - 删除UDisk

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDiskId (str) - (Required) 要删除的UDisk的Id
Zone (str) - (Required) 可用区。参见可用区列表

Response

delete_udisk_snapshot(req=None, **kwargs)[source]¶

DeleteUDiskSnapshot - 删除Snapshot

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - (Required) 可用区。参见可用区列表
SnapshotId (str) - 快照Id(填写后不能填写UDisk Id)
UDiskId (str) - UDisk Id,删除该盘所创建出来的所有快照(填写后不能填写SnapshotId)

Response

describe_udisk(req=None, **kwargs)[source]¶

DescribeUDisk - 获取UDisk实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DiskType (str) - ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:”CLOUD_NORMAL”,IsBoot:”False”；普通系统盘：DiskType:”CLOUD_NORMAL”,IsBoot:”True”；SSD数据盘：DiskType:”CLOUD_SSD”,IsBoot:”False”；SSD系统盘：DiskType:”CLOUD_SSD”,IsBoot:”True”；RSSD数据盘：DiskType:”CLOUD_RSSD”,IsBoot:”False”；为空拉取所有。ProtocolVersion字段为0或没有该字段时，可设为以下几个值:普通数据盘：DataDisk；普通系统盘；SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk；为空拉取所有。
IsBoot (str) - ProtocolVersion字段为1且DiskType不为空时，必须设置，设置规则请参照DiskType；ProtocolVersion字段为1且DiskType为空时，该字段无效。ProtocolVersion字段为0或没有该字段时，该字段无效。
Limit (int) - 返回数据长度, 默认为20
Offset (int) - 数据偏移量, 默认为0
ProtocolVersion (int) - 请求协议版本，建议升级为1，为1时DiskType与UHost磁盘类型定义一致；默认为0
UDiskId (str) - UDisk Id(留空返回全部)
Zone (str) - 可用区。参见可用区列表

Response

DataSet (list) - 见 UDiskDataSet 模型定义
TotalCount (int) - 根据过滤条件得到的总数

Response Model

UDiskDataSet

ArkSwitchEnable (int) - 是否支持开启方舟，1支持，0不支持
ChargeType (str) - Year,Month,Dynamic,Trial,Postpay
CloneEnable (int) - 是否支持克隆，1支持，0不支持
CmkId (str) - 该盘的cmk id
CmkIdAlias (str) - cmk id 别名
CmkIdStatus (str) - 该盘cmk的状态, Enabled(正常)，Disabled(失效)，Deleted(删除)，NoCmkId(非加密盘)
CreateTime (int) - 创建时间
DataKey (str) - 该盘的密文密钥
DeviceName (str) - 挂载的设备名称
DiskType (str) - 请求中的ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:”CLOUD_NORMAL”,IsBoot:”False”；普通系统盘：DiskType:”CLOUD_NORMAL”,IsBoot:”True”；SSD数据盘：DiskType:”CLOUD_SSD”,IsBoot:”False”；SSD系统盘：DiskType:”CLOUD_SSD”,IsBoot:”True”；RSSD数据盘：DiskType:”CLOUD_RSSD”,IsBoot:”False”。请求中的ProtocolVersion字段为0或没有该字段时，云硬盘类型参照如下:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk。
ExpiredTime (int) - 过期时间
IsBoot (str) - 是否是系统盘，是：”True”, 否：”False”
IsExpire (str) - 资源是否过期，过期:”Yes”, 未过期:”No”
Name (str) - 实例名称
Size (int) - 容量单位GB
SnapEnable (int) - 是否支持快照，1支持，0不支持
SnapshotCount (int) - 该盘快照个数
SnapshotLimit (int) - 该盘快照上限
Status (str) - 状态:Available(可用),Attaching(挂载中), InUse(已挂载), Detaching(卸载中), Initializating(分配中), Failed(创建失败),Cloning(克隆中),Restoring(恢复中),RestoreFailed(恢复失败),
Tag (str) - 业务组名称
UDataArkMode (str) - 是否开启数据方舟，开启:”Yes”, 不支持:”No”
UDiskId (str) - UDisk实例Id
UHostIP (str) - 挂载的UHost的IP
UHostId (str) - 挂载的UHost的Id
UHostName (str) - 挂载的UHost的Name
UKmsMode (str) - 是否是加密盘，是:”Yes”, 否:”No”
Version (str) - 是否支持数据方舟，支持:”2.0”, 不支持:”1.0”
Zone (str) - 可用区

describe_udisk_price(req=None, **kwargs)[source]¶

DescribeUDiskPrice - 获取UDisk实例价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 购买UDisk大小,单位:GB,范围[1~1000]
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year， Month， Dynamic，Trial，默认: Dynamic
DiskType (str) - UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），SystemDisk（普通系统盘），SSDSystemDisk（SSD系统盘），RSSDDataDisk（RSSD数据盘），默认值（DataDisk）
Quantity (int) - 购买UDisk的时长，默认值为1
UDataArkMode (str) - 是否打开数据方舟, 打开”Yes”,关闭”No”, 默认关闭

Response

DataSet (list) - 见 UDiskPriceDataSet 模型定义

Response Model

UDiskPriceDataSet

ChargeName (str) - “UDataArk”,”UDisk”
ChargeType (str) - Year， Month， Dynamic，Trial
OriginalPrice (int) - 用户折后价
Price (int) - 价格 (单位: 分)

describe_udisk_snapshot(req=None, **kwargs)[source]¶

DescribeUDiskSnapshot - 获取UDisk快照

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 返回数据长度, 默认为20
Offset (int) - 数据偏移量, 默认为0
SnapshotId (str) - 快照id，SnapshotId , UDiskId 同时传SnapshotId优先
UDiskId (str) - UDiskId,返回该盘所做快照.(必须同时传Zone)
Zone (str) - 可用区。参见可用区列表

Response

DataSet (list) - 见 UDiskSnapshotSet 模型定义
TotalCount (int) - 根据过滤条件得到的总数

Response Model

UDiskSnapshotSet

CmkId (str) - 该快照的cmk id
CmkIdAlias (str) - cmk id 别名
CmkIdStatus (str) - 该快照cmk的状态, Enabled(正常)，Disabled(失效)，Deleted(删除)，NoCmkId(非加密盘)
Comment (str) - 快照描述
CreateTime (int) - 创建时间
DataKey (str) - 该快照的密文密钥
DiskType (int) - 磁盘类型，0:数据盘，1:系统盘
ExpiredTime (int) - 过期时间
IsUDiskAvailable (bool) - 对应磁盘是否处于可用状态
Name (str) - 快照名称
Size (int) - 容量单位GB
SnapshotId (str) - 快照Id
Status (str) - 快照状态，Normal:正常,Failed:失败,Creating:制作中
UDiskId (str) - 快照的源UDisk的Id
UDiskName (str) - 快照的源UDisk的Name
UHostId (str) - 对应磁盘制作快照时所挂载的主机
UKmsMode (str) - 是否是加密盘快照，是:”Yes”, 否:”No”
Version (str) - 快照版本

describe_udisk_upgrade_price(req=None, **kwargs)[source]¶

DescribeUDiskUpgradePrice - 获取UDisk升级价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 购买UDisk大小,单位:GB,范围[1~2000], 权限位控制可达8T,若需要请申请开通相关权限。
SourceId (str) - (Required) 升级目标UDisk ID
Zone (str) - (Required) 可用区。参见可用区列表
DiskType (str) - 磁盘类型，SSDDataDisk:ssd数据盘,DataDisk:普通数据盘,SystemDisk:普通系统盘,SSDSystemDisk:ssd系统盘。默认为DataDisk
UDataArkMode (str) - 是否打开数据方舟, 打开”Yes”,关闭”No”, 默认关闭

Response

OriginalPrice (int) - 用户折后价
Price (int) - 价格

detach_udisk(req=None, **kwargs)[source]¶

DetachUDisk - 卸载某个已经挂载在指定UHost实例上的UDisk

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDiskId (str) - (Required) 需要卸载的UDisk实例ID
UHostId (str) - (Required) UHost实例ID
Zone (str) - (Required) 可用区。参见可用区列表

Response

UDiskId (str) - 卸载的UDisk实例ID
UHostId (str) - 卸载的UHost实例ID

rename_udisk(req=None, **kwargs)[source]¶

RenameUDisk - 重命名UDisk

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDiskId (str) - (Required) 重命名的UDisk的Id
UDiskName (str) - (Required) 重命名UDisk的name
Zone (str) - (Required) 可用区。参见可用区列表

Response

resize_udisk(req=None, **kwargs)[source]¶

ResizeUDisk - 调整UDisk容量

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 调整后大小, 单位:GB, 范围[1~2000],权限位控制可达8000,若需要请申请开通相关权限。
UDiskId (str) - (Required) UDisk Id
Zone (str) - (Required) 可用区。参见可用区列表
CouponId (str) - 使用的代金券id

Response

restore_udisk(req=None, **kwargs)[source]¶

RestoreUDisk - 从备份恢复数据至UDisk

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDiskId (str) - (Required) 需要恢复的盘id
Zone (str) - (Required) 可用区。参见可用区列表
SnapshotId (str) - 从指定的快照恢复
SnapshotTime (int) - 指定从方舟恢复的备份时间点

Response

set_udisk__udataark_mode(req=None, **kwargs)[source]¶

SetUDiskUDataArkMode - 设置UDisk数据方舟的状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDataArkMode (str) - (Required) 是否开启数据方舟，开启:”Yes”, 不支持:”No”
UDiskId (str) - (Required) 需要设置数据方舟的UDisk的Id
Zone (str) - (Required) 可用区。参见可用区列表

Response

UHost¶

class ucloud.services.uhost.client.UHostClient(config, transport=None, middleware=None, logger=None)[source]¶

copy_custom_image(req=None, **kwargs)[source]¶

CopyCustomImage - 复制自制镜像

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SourceImageId (str) - (Required) 源镜像Id, 参见 DescribeImage
TargetProjectId (str) - (Required) 目标项目Id, 参见 GetProjectList
TargetImageDescription (str) - 目标镜像描述
TargetImageName (str) - 目标镜像名称
TargetRegion (str) - 目标地域，不跨地域不用填
Zone (str) - 可用区。参见可用区列表

Response

TargetImageId (str) - 目标镜像Id

create_custom_image(req=None, **kwargs)[source]¶

CreateCustomImage - 从指定UHost实例，生成自定义镜像。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ImageName (str) - (Required) 镜像名称
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
ImageDescription (str) - 镜像描述
Zone (str) - 可用区。参见可用区列表

Response

ImageId (str) - 镜像Id

create_uhost_instance(req=None, **kwargs)[source]¶

CreateUHostInstance - 创建UHost实例。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ImageId (str) - (Required) 镜像ID。请通过 DescribeImage 获取
LoginMode (str) - (Required) 主机登陆模式。密码（默认选项）: Password。
Password (str) - (Required) UHost密码。请遵照字段规范设定密码。密码需使用base64进行编码，举例如下：# echo -n Password1 | base64UGFzc3dvcmQx。
Zone (str) - (Required) 可用区。参见可用区列表
AlarmTemplateId (int) - 告警模板id，如果传了告警模板id，且告警模板id正确，则绑定告警模板。绑定告警模板失败只会在后台有日志，不会影响创建主机流程，也不会在前端报错。
BootDiskSpace (int) - 【待废弃，不建议调用】系统盘大小。单位：GB，范围[20,100]，步长：10
CPU (int) - 虚拟CPU核数。可选参数：1-64（具体机型与CPU的对应关系参照控制台）。默认值: 4。
ChargeType (str) - 计费模式。枚举值为： > Year，按年付费； > Month，按月付费；> Dynamic，按小时预付费 > Postpay，按小时后付费（支持关机不收费，目前仅部分可用区支持，请联系您的客户经理）默认为月付
CouponId (str) - 主机代金券ID。请通过DescribeCoupon接口查询，或登录用户中心查看
DiskPassword (str) - 【待废弃，不建议调用】加密盘的密码。若输入此字段，自动选择加密盘。加密盘需要权限位。
DiskSpace (int) - 【待废弃，不建议调用】数据盘大小。单位：GB，范围[0,8000]，步长：10，默认值：20，云盘支持0-8000；本地普通盘支持0-2000；本地SSD盘（包括所有GPU机型）支持100-1000
Disks (list) - 见 CreateUHostInstanceParamDisks 模型定义
GPU (int) - GPU卡核心数。仅GPU机型支持此字段（可选范围与MachineType+GpuType相关）
GpuType (str) - GPU类型，枚举值[“K80”, “P40”, “V100”]，MachineType为G时必填
HostIp (str) - 指定宿主机创建，此时SetId为必填
HostType (str) - 【已废弃】宿主机类型，N2，N1
HotplugFeature (bool) - 热升级特性。True为开启，False为未开启，默认False。
InstallAgent (str) - 【暂不支持】是否安装UGA。’yes’: 安装；其他或者不填：不安装。
IsolationGroup (str) - 硬件隔离组id。可通过DescribeIsolationGroup获取。
KeyPair (str) - 【暂不支持】Keypair公钥，LoginMode为KeyPair时此项必须
MachineType (str) - 云主机机型（V2.0），在本字段和字段UHostType中，仅需要其中1个字段即可；当填写了MachineType时，必须填写MinimalCpuPlatform字段。枚举值[“N”, “C”, “G”, “O”]。参考云主机机型说明。
MaxCount (int) - 本次最大创建主机数量，取值范围是[1,100]，默认值为1。
Memory (int) - 内存大小。单位：MB。范围：[1024, 262144]，取值为1024的倍数（可选范围参考控制台）。默认值：8192
MinimalCpuPlatform (str) - 最低cpu平台，枚举值[“Intel/Auto”, “Intel/IvyBridge”, “Intel/Haswell”, “Intel/Broadwell”, “Intel/Skylake”, “Intel/Cascadelake”。
Name (str) - UHost实例名称。默认：UHost。请遵照字段规范设定实例名称。
NetCapability (str) - 网络增强特性。枚举值：Normal（默认），不开启; Super，开启网络增强1.0； Ultra，开启网络增强2.0（仅支持部分可用区，请参考控制台）
NetworkId (str) - 【已废弃】网络ID（VPC2.0情况下无需填写）。VPC1.0情况下，若不填写，代表优先选择基础网络；若填写，代表选择子网。参见DescribeSubnet。
NetworkInterface (list) - 见 CreateUHostInstanceParamNetworkInterface 模型定义
PrivateIp (list) - 【数组】创建云主机时指定内网IP。若不传值，则随机分配当前子网下的IP。调用方式举例：PrivateIp.0=x.x.x.x。当前只支持一个内网IP。
PrivateMac (str) - 【批量创建该参数无效】【内部字段】创建云主机时指定Mac。调用方式举例：PrivateMac=”xx:xx:xx:xx:xx:xx”。
Quantity (int) - 购买时长。默认:值 1。按小时购买（Dynamic/Postpay）时无需此参数。月付时，此参数传0，代表购买至月末。
ResourceType (int) - 【内部参数】资源类型
SecurityGroupId (str) - 防火墙ID，默认：Web推荐防火墙。如何查询SecurityGroupId请参见 DescribeFirewall 。
SetId (int) - 指定set创建
StorageType (str) - 【待废弃，不建议调用】磁盘类型，同时设定系统盘和数据盘的磁盘类型。枚举值为：LocalDisk，本地磁盘; UDisk，云硬盘；默认为LocalDisk。仅部分可用区支持云硬盘方式的主机存储方式，具体请查询控制台。
SubnetId (str) - 子网 ID。默认为当前地域的默认子网。
Tag (str) - 业务组。默认：Default（Default即为未分组）。请遵照字段规范设定业务组。
TimemachineFeature (str) - 【待废弃，不建议调用】是否开启方舟特性。Yes为开启方舟，No为关闭方舟。目前仅选择普通本地盘+普通本地盘或 SSD云盘+普通云盘的组合支持开启方舟。
UHostType (str) - 【建议后续不再使用】云主机机型（V1.0），在本字段和字段MachineType中，仅需要其中1个字段即可。参考云主机机型说明。
UserData (str) - 【即将支持】用户自定义数据。当镜像支持Cloud-init Feature时可填写此字段。注意：1、总数据量大小不超多16K；2、使用base64编码
UserDataScript (str) - 【暂不支持】cloudinit方式下，用户初始化脚本
VPCId (str) - VPC ID。默认为当前地域的默认VPC。

Response

IPs (list) - 【批量创建不会返回】IP信息
UHostIds (list) - UHost实例Id集合

Request Model

CreateUHostInstanceParamNetworkInterfaceEIPGlobalSSH

Area (str) - 填写支持SSH访问IP的地区名称，如“洛杉矶”，“新加坡”，“香港”，“东京”，“华盛顿”，“法兰克福”。Area和AreaCode两者必填其中之一。
AreaCode (str) - GlobalSSH的地区编码，格式为区域航空港国际通用代码。Area和AreaCode两者必填其中之一。
Port (int) - SSH端口，1-65535且不能使用80，443端口

CreateUHostInstanceParamNetworkInterfaceEIP

Bandwidth (int) - 【若绑定EIP，此参数必填】弹性IP的外网带宽, 单位为Mbps. 共享带宽模式必须指定0M带宽, 非共享带宽模式必须指定非0Mbps带宽. 各地域非共享带宽的带宽范围如下：流量计费[1-300]，带宽计费[1-800]
CouponId (str) - 当前EIP代金券id。请通过DescribeCoupon接口查询，或登录用户中心查看。
GlobalSSH (dict) - 见 CreateUHostInstanceParamNetworkInterfaceEIPGlobalSSH 模型定义
OperatorName (str) - 【若绑定EIP，此参数必填】弹性IP的线路。枚举值: 国际: International BGP: Bgp 各地域允许的线路参数如下: cn-sh1: Bgp cn-sh2: Bgp cn-gd: Bgp cn-bj1: Bgp cn-bj2: Bgp hk: International us-ca: International th-bkk: International kr-seoul:International us-ws:International ge-fra:International sg:International tw-kh:International.其他海外线路均为 International
PayMode (str) - 弹性IP的计费模式. 枚举值: “Traffic”, 流量计费; “Bandwidth”, 带宽计费; “ShareBandwidth”,共享带宽模式. “Free”:免费带宽模式.默认为 “Bandwidth”.
ShareBandwidthId (str) - 绑定的共享带宽Id，仅当PayMode为ShareBandwidth时有效

CreateUHostInstanceParamNetworkInterfaceIPv6

Adress (str) - 第N个网卡对应的IPv6地址，默认不分配IPv6，“Auto”自动分配，不为空的其他字符串为实际要分配的IPv6地址
ShareBandwidthId (str) - 第N块网卡中IPv6对应的共享带宽id，默认不带外网

CreateUHostInstanceParamDisks

BackupType (str) - 磁盘备份方案。枚举值：> NONE，无备份 > DATAARK，数据方舟当前磁盘支持的备份模式参考磁盘类型
CouponId (str) - 云盘代金券id。不适用于系统盘/本地盘。请通过DescribeCoupon接口查询，或登录用户中心查看
Encrypted (bool) - 【功能仅部分可用区开放，详询技术支持】磁盘是否加密。加密：true, 不加密: false加密必须传入对应的的KmsKeyId
IsBoot (str) - 是否是系统盘。枚举值：> True，是系统盘 > False，是数据盘（默认）。Disks数组中有且只能有一块盘是系统盘。
KmsKeyId (str) - 【功能仅部分可用区开放，详询技术支持】kms key id。选择加密盘时必填。
Size (int) - 磁盘大小，单位GB，必须是10GB的整数倍。请参考磁盘类型。
Type (str) - 磁盘类型。请参考磁盘类型。

CreateUHostInstanceParamNetworkInterface

EIP (dict) - 见 CreateUHostInstanceParamNetworkInterfaceEIP 模型定义
IPv6 (dict) - 见 CreateUHostInstanceParamNetworkInterfaceIPv6 模型定义

describe_image(req=None, **kwargs)[source]¶

DescribeImage - 获取指定数据中心镜像列表，用户可通过指定操作系统类型，镜像Id进行过滤。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ImageId (str) - 镜像Id
ImageType (str) - 镜像类型。标准镜像：Base，镜像市场：Business，自定义镜像：Custom，默认返回所有类型
Limit (int) - 返回数据长度，默认为20
Offset (int) - 列表起始位置偏移量，默认为0
OsType (str) - 操作系统类型：Linux， Windows 默认返回所有类型
PriceSet (int) - 是否返回价格：1返回，0不返回；默认不返回
Zone (str) - 可用区。参见可用区列表

Response

ImageSet (list) - 见 UHostImageSet 模型定义
TotalCount (int) - 满足条件的镜像总数

Response Model

UHostImageSet

CreateTime (int) - 创建时间，格式为Unix时间戳
Features (list) - 特殊状态标识，目前包含NetEnhnced（网络增强1.0）, NetEnhanced_Ultra]（网络增强2.0）,HotPlug(热升级),CloudInit
FuncType (str) - 行业镜像类型（仅行业镜像将返回这个值）
ImageDescription (str) - 镜像描述
ImageId (str) - 镜像ID
ImageName (str) - 镜像名称
ImageSize (int) - 镜像大小
ImageType (str) - 镜像类型标准镜像：Base，行业镜像：Business，自定义镜像：Custom
IntegratedSoftware (str) - 集成软件名称（仅行业镜像将返回这个值）
Links (str) - 介绍链接（仅行业镜像将返回这个值）
MinimalCPU (str) - 默认值为空’’’。当CentOS 7.3/7.4/7.5等镜像会标记为“Broadwell”
OsName (str) - 操作系统名称
OsType (str) - 操作系统类型：Liunx，Windows
State (str) - 镜像状态，可用：Available，制作中：Making，不可用：Unavailable
Vendor (str) - 供应商（仅行业镜像将返回这个值）
Zone (str) - 可用区，参见可用区列表

describe_isolation_group(req=None, **kwargs)[source]¶

DescribeIsolationGroup - 查询硬件隔离组列表。

Request

ProjectId (str) - (Config) 项目id
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - 待查的硬件隔离组id
Limit (int) - 返回数据长度，默认为20，最大100
Offset (int) - 列表起始位置偏移量，默认为0

Response

IsolationGroupSet (list) - 见 IsolationGroup 模型定义

Response Model

SpreadInfo

UHostCount (int) - 可用区中硬件隔离组中云主机的数量，不超过7。
Zone (str) - 可用区信息

IsolationGroup

GroupId (str) - 硬件隔离组id
GroupName (str) - 硬件隔离组名称
Remark (str) - 备注
SpreadInfoSet (list) - 见 SpreadInfo 模型定义

describe_uhost_instance(req=None, **kwargs)[source]¶

DescribeUHostInstance - 获取主机或主机列表信息，并可根据数据中心，主机ID等参数进行过滤。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
IsolationGroup (str) - 硬件隔离组id。通过硬件隔离组筛选主机。
LifeCycle (int) - 1：普通云主机；2：抢占型云主机；如不传此参数，默认全部获取
Limit (int) - 返回数据长度，默认为20，最大100
Offset (int) - 列表起始位置偏移量，默认为0
SubnetId (str) - 子网id。通过子网筛选主机。北京一地域无效。
Tag (str) - 要查询的业务组名称
UHostIds (list) - 【数组】UHost主机的资源ID，例如UHostIds.0代表希望获取信息的主机1，UHostIds.1代表主机2。如果不传入，则返回当前Region 所有符合条件的UHost实例。
VPCId (str) - vpc id。通过VPC筛选主机。北京一地域无效。
Zone (str) - 可用区。参见可用区列表

Response

Action (str) - 操作名称
RetCode (int) - 返回码
TotalCount (int) - UHostInstance总数
UHostSet (list) - 见 UHostInstanceSet 模型定义

Response Model

UHostDiskSet

BackupType (str) - 备份方案。若开通了数据方舟，则为DataArk
DiskId (str) - 磁盘ID
DiskType (str) - 磁盘类型。请参考磁盘类型。
Drive (str) - 磁盘盘符
Encrypted (bool) - true: 加密盘 false：非加密盘
IsBoot (str) - 是否是系统盘。枚举值：> True，是系统盘 > False，是数据盘（默认）。Disks数组中有且只能有一块盘是系统盘。
Name (str) - UDisk名字（仅当磁盘是UDisk时返回）
Size (int) - 磁盘大小，单位: GB
Type (str) - 【建议不再使用】磁盘类型。系统盘: Boot，数据盘: Data,网络盘：Udisk

UHostIPSet

Bandwidth (int) - IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)
Default (str) - 【暂未支持】是否为默认网卡。True: 是默认网卡；其他值：不是。
IP (str) - IP地址
IPId (str) - 外网IP资源ID 。(内网IP无对应的资源ID)
Mac (str) - 当前网卡的Mac。
SubnetId (str) - IP地址对应的子网 ID。（北京一不支持，字段返回为空）
Type (str) - 国际: Internation，BGP: Bgp，内网: Private
VPCId (str) - IP地址对应的VPC ID。（北京一不支持，字段返回为空）
Weight (int) - 当前EIP的权重。权重最大的为当前的出口IP。

UHostInstanceSet

AutoRenew (str) - 是否自动续费，自动续费：“Yes”，不自动续费：“No”
BasicImageId (str) - 基础镜像ID（指当前自定义镜像的来源镜像）
BasicImageName (str) - 基础镜像名称（指当前自定义镜像的来源镜像）
BootDiskState (str) - 系统盘状态 Normal表示初始化完成；Initializing表示在初始化。仍在初始化的系统盘无法制作镜像。
CPU (int) - 虚拟CPU核数，单位: 个
ChargeType (str) - 计费模式，枚举值为： Year，按年付费； Month，按月付费； Dynamic，按需付费（需开启权限）；
CreateTime (int) - 创建时间，格式为Unix时间戳
DiskSet (list) - 见 UHostDiskSet 模型定义
ExpireTime (int) - 到期时间，格式为Unix时间戳
GPU (int) - GPU个数
HostType (str) - 【建议不再使用】主机系列：N2，表示系列2；N1，表示系列1
HotplugFeature (bool) - true: 开启热升级； false，未开启热升级
IPSet (list) - 见 UHostIPSet 模型定义
ImageId (str) - 【建议不再使用】主机的系统盘ID。
IsolationGroup (str) - 隔离组id，不在隔离组则返回””
LifeCycle (str) - 主机的生命周期类型。目前仅支持Normal：普通；
MachineType (str) - 云主机机型（新）。参考云主机机型说明。
Memory (int) - 内存大小，单位: MB
Name (str) - UHost实例名称
NetCapability (str) - 网络增强。Normal: 无；Super：网络增强1.0； Ultra: 网络增强2.0
NetworkState (str) - 【建议不再使用】网络状态。连接：Connected，断开：NotConnected
OsName (str) - 创建主机的最初来源镜像的操作系统名称（若直接通过基础镜像创建，此处返回和BasicImageName一致）
OsType (str) - 操作系统类别。返回”Linux”或者”Windows”
Remark (str) - 备注
State (str) - 实例状态，枚举值：>初始化: Initializing; >启动中: Starting; > 运行中: Running; > 关机中: Stopping; >关机: Stopped >安装失败: Install Fail; >重启中: Rebooting
StorageType (str) - 【建议不再使用】主机磁盘类型。枚举值为：> LocalDisk，本地磁盘; > UDisk 云盘。只要有一块磁盘为本地盘，即返回LocalDisk。
SubnetType (str) - 【建议不再使用】仅北京A的云主机会返回此字段。基础网络模式：Default；子网模式：Private
Tag (str) - 业务组名称
TimemachineFeature (str) - 【建议不再使用】数据方舟模式。枚举值：> Yes: 开启方舟； > no，未开启方舟
TotalDiskSpace (int) - 总的数据盘存储空间。
UHostId (str) - UHost实例ID
UHostType (str) - 【建议不再使用】云主机机型（旧）。参考云主机机型说明。
Zone (str) - 可用区。参见可用区列表

describe_uhost_instance_snapshot(req=None, **kwargs)[source]¶

DescribeUHostInstanceSnapshot - 获取已经存在的UHost实例的存储快照列表。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
Zone (str) - 可用区。参见可用区列表

Response

SnapshotSet (list) - 见 UHostSnapshotSet 模型定义
UhostId (str) - UHost实例ID

Response Model

UHostSnapshotSet

SnapshotName (str) - 快照名称
SnapshotState (str) - 快照状态, 制作中:Capturing 制作成功:Success 制作失败:Fail
SnapshotTime (str) - 快照制作时间

describe_uhost_tags(req=None, **kwargs)[source]¶

DescribeUHostTags - 获取指定数据中心的业务组列表。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - 可用区。参见可用区列表

Response

TagSet (list) - 见 UHostTagSet 模型定义
TotalCount (int) - 已有主机的业务组总个数

Response Model

UHostTagSet

Tag (str) - 业务组名称
TotalCount (int) - 该业务组中包含的主机个数
Zone (str) - 可用区

get_uhost_instance_price(req=None, **kwargs)[source]¶

GetUHostInstancePrice - 根据UHost实例配置，获取UHost实例的价格。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
CPU (int) - (Required) CPU核数。可选参数：1-64。可选范围参照控制台。默认值: 4
Count (int) - (Required) 购买台数，范围[1,5]
ImageId (str) - (Required) 镜像Id，可通过 DescribeImage 获取镜像ID
Memory (int) - (Required) 内存大小。单位：MB。范围：[1024, 262144]，取值为1024的倍数（可选范围参照好控制台）。默认值：8192
ChargeType (str) - 计费模式。枚举值为： > Year，按年付费； > Month，按月付费；> Dynamic，按小时付费默认为月付。
DiskSpace (int) - 【待废弃】数据盘大小，单位: GB，范围[0,1000]，步长: 10，默认值: 0
Disks (list) - 见 GetUHostInstancePriceParamDisks 模型定义
GPU (int) - GPU卡核心数。仅GPU机型支持此字段。
GpuType (str) - GPU类型，枚举值[“K80”, “P40”, “V100”]
LifeCycle (int) - 【未支持】1：普通云主机；2：抢占性云主机；默认普通
MachineType (str) - 云主机机型（V2版本概念）。枚举值[“N”, “C”, “G”, “O”]。参考云主机机型说明。
NetCapability (str) - 网络增强。枚举值：Normal，不开启; Super，开启网络增强1.0。默认值为Normal。
Quantity (int) - 购买时长。默认: 1。按小时购买(Dynamic)时无需此参数。月付时，此参数传0，代表了购买至月末。
StorageType (str) - 【待废弃】磁盘类型，同时设定系统盘和数据盘，枚举值为：LocalDisk，本地磁盘; UDisk，云硬盘; 默认为LocalDisk 仅部分可用区支持云硬盘方式的主机存储方式，具体请查询控制台。
TimemachineFeature (str) - 【待废弃】方舟机型。No，Yes。默认是No。
UHostType (str) - 【待废弃】云主机机型（V1版本概念）。参考云主机机型说明。
Zone (str) - 可用区。参见可用区列表

Response

PriceSet (list) - 见 UHostPriceSet 模型定义

Request Model

GetUHostInstancePriceParamDisks

BackupType (str) - 磁盘备份方案。枚举值：> NONE，无备份 > DATAARK，数据方舟当前磁盘支持的备份模式参考磁盘类型
IsBoot (str) - 是否是系统盘。枚举值：> True，是系统盘 > False，是数据盘（默认）。Disks数组中有且只能有一块盘是系统盘。
Size (int) - 磁盘大小，单位GB。请参考磁盘类型。
Type (str) - 磁盘类型。请参考磁盘类型。

Response Model

UHostPriceSet

ChargeType (str) - 计费类型。Year，Month，Dynamic
Price (float) - 价格，单位: 元，保留小数点后两位有效数字

get_uhost_instance_vnc_info(req=None, **kwargs)[source]¶

GetUHostInstanceVncInfo - 获取指定UHost实例的管理VNC配置详细信息。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID
VncIP (str) - Vnc登录IP
VncPassword (str) - Vnc 登录密码
VncPort (int) - Vnc登录端口

get_uhost_upgrade_price(req=None, **kwargs)[source]¶

GetUHostUpgradePrice - 获取UHost实例升级配置的价格。可选配置范围请参考云主机机型说明。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID。参见 DescribeUHostInstance 。
BootDiskSpace (int) - 【待废弃】系统大小，单位: GB，范围[20,100]，步长: 10。
CPU (int) - 虚拟CPU核数。可选参数：1-64（可选范围参考控制台）。默认值为当前实例的CPU核数。
DiskSpace (int) - 【待废弃】数据盘大小，单位: GB，范围[0,1000]，步长: 10，默认值是该主机当前数据盘大小。
HostType (str) - 【待废弃】主机系列，目前支持N1,N2
Memory (int) - 内存大小。单位：MB。范围：[1024, 262144]，取值为1024的倍数（可选范围参考控制台）。默认值为当前实例的内存大小。
NetCapValue (int) - 网卡升降级（1，表示升级，2表示降级，0表示不变）
TimemachineFeature (str) - 方舟机型。No，Yes。默认是No。
Zone (str) - 可用区。参见可用区列表

Response

Price (float) - 规格调整差价。精确到小数点后2位。

import_custom_image(req=None, **kwargs)[source]¶

ImportCustomImage - 把UFile的镜像文件导入到UHost，生成自定义镜像

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Auth (bool) - (Required) 是否授权。必须填true
Format (str) - (Required) 镜像格式，可选RAW、VHD、VMDK、qcow2
ImageName (str) - (Required) 镜像名称
OsName (str) - (Required) 操作系统详细版本，请参考控制台的镜像版本；OsType为Other时，输入参数为Other
OsType (str) - (Required) 操作系统平台，比如CentOS、Ubuntu、Windows、RedHat等，请参考控制台的镜像版本；若导入控制台上没有的操作系统，参数为Other
UFileUrl (str) - (Required) UFile私有空间地址
ImageDescription (str) - 镜像描述

Response

ImageId (str) - 镜像Id

modify_uhost_instance_name(req=None, **kwargs)[source]¶

ModifyUHostInstanceName - 修改指定UHost实例名称，需要给出数据中心，UHostId，及新的实例名称。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
Name (str) - UHost实例名称
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID

modify_uhost_instance_remark(req=None, **kwargs)[source]¶

ModifyUHostInstanceRemark - 修改指定UHost实例备注信息。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
Remark (str) - 备注
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID

modify_uhost_instance_tag(req=None, **kwargs)[source]¶

ModifyUHostInstanceTag - 修改指定UHost实例业务组标识。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
Tag (str) - 业务组名称
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID

poweroff_uhost_instance(req=None, **kwargs)[source]¶

PoweroffUHostInstance - 直接关闭UHost实例电源，无需等待实例正常关闭。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID

reboot_uhost_instance(req=None, **kwargs)[source]¶

RebootUHostInstance - 重新启动UHost实例，需要指定数据中心及UHostID两个参数的值。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
DiskPassword (str) - 加密盘密码
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID

reinstall_uhost_instance(req=None, **kwargs)[source]¶

ReinstallUHostInstance - 重新安装指定UHost实例的操作系统

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例资源ID 参见 DescribeUHostInstance
DNSServers (list) - 针对非私有子网主机，可自定义DNS。n可为0-2
ImageId (str) - 镜像Id，默认使用原镜像参见 DescribeImage
Password (str) - 如果创建UHost实例时LoginMode为Password，则必须填写，如果LoginMode为KeyPair，不需要填写（密码格式使用BASE64编码；LoginMode不可变更）
ReserveDisk (str) - 是否保留数据盘，保留：Yes，不报留：No，默认：Yes
ResourceType (int) - 云灾备指明191
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例资源ID

reset_uhost_instance_password(req=None, **kwargs)[source]¶

ResetUHostInstancePassword - 重置UHost实例的管理员密码。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Password (str) - (Required) UHost新密码（密码格式使用BASE64编码）
UHostId (str) - (Required) UHost实例ID
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID

resize_attached_disk(req=None, **kwargs)[source]¶

ResizeAttachedDisk - 修改挂载的磁盘大小，包含系统盘和数据盘

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DiskId (str) - (Required) 磁盘ID。参见 DescribeUHostInstance 返回值中的DiskSet。
DiskSpace (int) - (Required) 磁盘大小，单位GB，步长为10。取值范围需大于当前磁盘大小，最大值请参考磁盘类型。
UHostId (str) - (Required) UHost实例ID。参见 DescribeUHostInstance 。
Zone (str) - (Required) 可用区。参见可用区列表

Response

DiskId (str) - 改配成功的磁盘id

resize_uhost_instance(req=None, **kwargs)[source]¶

ResizeUHostInstance - 修改指定UHost实例的资源配置，如CPU核心数，内存容量大小，磁盘空间大小,网络增强等。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
BootDiskSpace (int) - 系统盘大小，单位：GB，范围[20,100]，步长：10，系统盘不支持缩容，因此不允许输入比当前实例系统盘小的值
CPU (int) - 虚拟CPU核数，单位：个，范围：[1,16]，最小值为1，其他值是2的倍数，默认值为当前实例的CPU核数（*windows CPU>=2）
DiskSpace (int) - 数据盘大小，单位：GB，范围[10,1000]； SSD机型，单位：GB，范围[100,500]；步长：10，默认值为当前实例的数据盘大小，数据盘不支持缩容，因此不允许输入比当前实例数据盘大小的值
Memory (int) - 内存大小，单位：MB，范围[2048,65536]，步长：2048，默认值为当前实例的内存大小（BGP-C数据中心最小支持1024，限Linux系统）
NetCapValue (int) - 网卡升降级（1，表示升级，2表示降级，0表示不变）
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID

start_uhost_instance(req=None, **kwargs)[source]¶

StartUHostInstance - 启动处于关闭状态的UHost实例，需要指定数据中心及UHostID两个参数的值。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
DiskPassword (str) - 加密盘密码
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID

stop_uhost_instance(req=None, **kwargs)[source]¶

StopUHostInstance - 指停止处于运行状态的UHost实例，需指定数据中心及UhostID。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
Zone (str) - 可用区。参见可用区列表

Response

UhostId (str) - UHost实例ID

terminate_custom_image(req=None, **kwargs)[source]¶

TerminateCustomImage - 删除用户自定义镜像

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ImageId (str) - (Required) 自制镜像ID 参见 DescribeImage
Zone (str) - 可用区。参见可用区列表

Response

ImageId (str) - 自制镜像Id

terminate_uhost_instance(req=None, **kwargs)[source]¶

TerminateUHostInstance - 删除指定数据中心的UHost实例。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost资源Id 参见 DescribeUHostInstance
Destroy (int) - 是否直接删除，0表示按照原来的逻辑（有回收站权限，则进入回收站），1表示直接删除
ReleaseEIP (bool) - 是否释放绑定的EIP。true: 解绑EIP后，并释放；其他值或不填：解绑EIP。
ReleaseUDisk (bool) - 是否删除挂载的数据盘。true删除，其他不删除。
Zone (str) - 可用区。参见可用区列表

Response

InRecycle (str) - 放入回收站:”Yes”, 彻底删除：“No”
UHostId (str) - UHost 实例 Id

upgrade_to_ark_uhost_instance(req=None, **kwargs)[source]¶

UpgradeToArkUHostInstance - 普通升级为方舟机型

Request

Region (str) - (Config) 地域。参见地域和可用区列表
UHostIds (list) - (Required) UHost主机的资源ID，例如UHostIds.0代表希望升级的主机1，UHostIds.1代表主机2。
Zone (str) - (Required) 可用区。参见可用区列表
CouponId (str) - 代金券ID 请参考DescribeCoupon接口

Response

UHostSet (list) - UHost主机的资源ID数组

ULB¶

class ucloud.services.ulb.client.ULBClient(config, transport=None, middleware=None, logger=None)[source]¶

allocate_backend(req=None, **kwargs)[source]¶

AllocateBackend - 添加ULB后端资源实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ResourceId (str) - (Required) 所添加的后端资源的资源ID
ResourceType (str) - (Required) 所添加的后端资源的类型，枚举值：UHost -> 云主机；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器，默认值为“UHost”
ULBId (str) - (Required) 负载均衡实例的ID
VServerId (str) - (Required) VServer实例的ID
Enabled (int) - 后端实例状态开关，枚举值： 1：启用； 0：禁用默认为启用
Port (int) - 所添加的后端资源服务端口，取值范围[1-65535]，默认80
Weight (int) - 所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1

Response

BackendId (str) - 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关），可用于 UpdateBackendAttribute/UpdateBackendAttributeBatch/ReleaseBackend

allocate_backend_batch(req=None, **kwargs)[source]¶

AllocateBackendBatch - 批量添加VServer后端节点

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Backends (list) - (Required) 用| 分割字段，格式：ResourceId| ResourceType| Port| Enabled|IP| Weight。ResourceId:所添加的后端资源的资源ID；ResourceType:所添加的后端资源的类型，枚举值：UHost -> 云主机；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器，默认值为“UHost”；Port:所添加的后端资源服务端口，取值范围[1-65535]；Enabled:后端实例状态开关，枚举值： 1：启用； 0：禁用；IP:后端资源内网ip；Weight：所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1
ULBId (str) - (Required) 负载均衡实例的ID
VServerId (str) - (Required) VServer实例的ID
ApiVersion (int) -

Response

BackendSet (list) - 见 BackendSet 模型定义

Response Model

BackendSet

BackendId (str) - rs的资源ID
ResourceId (str) - rs对应的UHost ID

bind_ssl(req=None, **kwargs)[source]¶

BindSSL - 将SSL证书绑定到VServer

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SSLId (str) - (Required) SSL证书的Id
ULBId (str) - (Required) 所绑定ULB实例ID
VServerId (str) - (Required) 所绑定VServer实例ID

Response

create_policy(req=None, **kwargs)[source]¶

CreatePolicy - 创建VServer内容转发策略

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackendId (list) - (Required) 内容转发策略应用的后端资源实例的ID，来源于 AllocateBackend 返回的 BackendId
Match (str) - (Required) 内容转发匹配字段
ULBId (str) - (Required) 需要添加内容转发策略的负载均衡实例ID
VServerId (str) - (Required) 需要添加内容转发策略的VServer实例ID
Type (str) - 内容转发匹配字段的类型

Response

PolicyId (str) - 内容转发策略ID

create_ssl(req=None, **kwargs)[source]¶

CreateSSL - 创建SSL证书，可以把整个 Pem 证书内容传过来，或者把证书、私钥、CA证书分别传过来

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SSLName (str) - (Required) SSL证书的名字，默认值为空
CaCert (str) - CA证书
PrivateKey (str) - 加密证书的私钥
SSLContent (str) - SSL证书的完整内容，包括用户证书、加密证书的私钥、CA证书
SSLType (str) - 所添加的SSL证书类型，目前只支持Pem格式
UserCert (str) - 用户的证书

Response

SSLId (str) - SSL证书的Id

create_ulb(req=None, **kwargs)[source]¶

CreateULB - 创建负载均衡实例，可以选择内网或者外网

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BusinessId (str) - ULB 所属的业务组ID，如果不传则使用默认的业务组
ChargeType (str) - 付费方式
IPVersion (str) - ULB ip类型，枚举值：IPv6 / IPv4 （内部测试，暂未对外开放）
InnerMode (str) - 创建的ULB是否为内网模式
ListenType (str) - ULB 监听器类型，枚举值：RequestProxy / PacketsTransmit （内部测试，暂未对外开放）
OuterMode (str) - 创建的ULB是否为外网模式，默认即为外网模式
PrivateIp (str) - 创建内网ULB时指定内网IP。若不传值，则随机分配当前子网下的IP（暂时不对外开放，创建外网ULB该字段会忽略）
Remark (str) - 备注
SubnetId (str) - 内网ULB 所属的子网ID，如果不传则使用默认的子网
Tag (str) - 业务组
ULBName (str) - 负载均衡的名字，默认值为“ULB”
VPCId (str) - ULB所在的VPC的ID, 如果不传则使用默认的VPC

Response

ULBId (str) - 负载均衡实例的Id

create_vserver(req=None, **kwargs)[source]¶

CreateVServer - 创建VServer实例，定义监听的协议和端口以及负载均衡算法

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ULBId (str) - (Required) 负载均衡实例ID
ClientTimeout (int) - ListenType为RequestProxy时表示空闲连接的回收时间，单位：秒，取值范围：时(0，86400]，默认值为60；ListenType为PacketsTransmit时表示连接保持的时间，单位：秒，取值范围：[60，900]，0 表示禁用连接保持
Domain (str) - 根据MonitorType确认；当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查域名
FrontendPort (int) - VServer后端端口，取值范围[1-65535]；默认值为80
ListenType (str) - 监听器类型，枚举值为：RequestProxy -> 请求代理；PacketsTransmit -> 报文转发；默认为”RequestProxy”
Method (str) - VServer负载均衡模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）; WeightRoundrobin -> 加权轮询; Leastconn -> 最小连接数。ConsistentHash，SourcePort，ConsistentHashPort 只在报文转发中使用；Leastconn只在请求代理中使用；Roundrobin、Source和WeightRoundrobin在请求代理和报文转发中使用。默认为：”Roundrobin”
MonitorType (str) - 健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；
Path (str) - 根据MonitorType确认；当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查路径
PersistenceInfo (str) - 根据PersistenceType确认； None和ServerInsert：此字段无意义； UserDefined：此字段传入自定义会话保持String
PersistenceType (str) - VServer会话保持方式，默认关闭会话保持。枚举值：None -> 关闭；ServerInsert -> 自动生成KEY；UserDefined -> 用户自定义KEY。
Protocol (str) - VServer实例的协议，请求代理模式下有 HTTP、HTTPS、TCP，报文转发下有 TCP，UDP。默认为“HTTP”
VServerName (str) - VServer实例名称，默认为”VServer”

Response

VServerId (str) - VServer实例的Id

delete_policy(req=None, **kwargs)[source]¶

DeletePolicy - 删除内容转发策略

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PolicyId (str) - (Required) 内容转发策略ID
GroupId (str) - 内容转发策略组ID
VServerId (str) - VServer 资源ID

Response

delete_ssl(req=None, **kwargs)[source]¶

DeleteSSL - 删除SSL证书

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SSLId (str) - (Required) SSL证书的ID

Response

delete_ulb(req=None, **kwargs)[source]¶

DeleteULB - 删除负载均衡实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ULBId (str) - (Required) 负载均衡实例的ID
ReleaseEip (bool) - 删除ulb时是否释放绑定的EIP，false标识只解绑EIP，true表示会释放绑定的EIP，默认是false

Response

delete_vserver(req=None, **kwargs)[source]¶

DeleteVServer - 删除VServer实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ULBId (str) - (Required) 负载均衡实例的ID
VServerId (str) - (Required) VServer实例的ID

Response

describe_ssl(req=None, **kwargs)[source]¶

DescribeSSL - 获取SSL证书信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 数据分页值，默认为20
Offset (int) - 数据偏移量，默认值为0
SSLId (str) - SSL证书的Id

Response

DataSet (list) - 见 ULBSSLSet 模型定义
TotalCount (int) - 满足条件的SSL证书总数

Response Model

ULBSSLSet

HashValue (str) -
SSLId (str) - SSL证书的Id
SSLName (str) - SSL证书的名字

describe_ulb(req=None, **kwargs)[source]¶

DescribeULB - 获取ULB详细信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BusinessId (str) - ULB所属的业务组ID
Limit (int) - 数据分页值，默认为20
Offset (int) - 数据偏移量，默认为0
SubnetId (str) - ULB所属的子网ID
ULBId (str) - 负载均衡实例的Id。若指定则返回指定的负载均衡实例的信息；若不指定则返回当前数据中心中所有的负载均衡实例的信息
VPCId (str) - ULB所属的VPC

Response

DataSet (list) - 见 ULBSet 模型定义
TotalCount (int) - 满足条件的ULB总数

Response Model

PolicyBackendSet

BackendId (str) - 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关
ObjectId (str) - 后端资源的对象ID
Port (int) - 所添加的后端资源服务端口
PrivateIP (str) - 后端资源的内网IP
ResourceName (str) - 后端资源的实例名称

ULBPolicySet

BackendSet (list) - 见 PolicyBackendSet 模型定义
Match (str) - 内容转发匹配字段;默认内容转发类型下为空。
PolicyId (str) - 内容转发Id，默认内容转发类型下为空。
PolicyPriority (int) - 内容转发优先级，范围[1,9999]，数字越大优先级越高。默认内容转发规则下为0。
PolicyType (str) - 内容类型，枚举值：Custom -> 客户自定义；Default -> 默认内容转发
TotalCount (int) - 默认内容转发类型下返回当前rs总数
Type (str) - 内容转发匹配字段的类型，枚举值：Domain -> 域名；Path -> 路径；默认内容转发类型下为空
VServerId (str) - 所属VServerId

ULBBackendSet

BackendId (str) - 后端资源实例的Id
Enabled (int) - 后端提供服务的实例启用与否，枚举值：0 禁用 1 启用
Port (int) - 后端提供服务的端口
PrivateIP (str) - 后端提供服务的内网IP
ResourceId (str) - 资源实例的资源Id
ResourceName (str) - 资源实例的资源名称
ResourceType (str) - 资源实例的类型
Status (int) - 后端提供服务的实例运行状态，枚举值：0健康检查健康状态 1 健康检查异常
SubResourceId (str) - 资源绑定的虚拟网卡实例的资源Id
SubResourceName (str) - 资源绑定的虚拟网卡实例的资源名称
SubResourceType (str) - 资源绑定的虚拟网卡实例的类型
SubnetId (str) - 后端提供服务的资源所在的子网的ID
Weight (int) -

ULBSSLSet

HashValue (str) -
SSLId (str) - SSL证书的Id
SSLName (str) - SSL证书的名字

ULBVServerSet

BackendSet (list) - 见 ULBBackendSet 模型定义
ClientTimeout (int) - 空闲连接的回收时间，单位：秒。
Domain (str) - 根据MonitorType确认；当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查域名
FrontendPort (int) - VServer服务端口
ListenType (str) - 监听器类型，枚举值为: RequestProxy -> 请求代理；PacketsTransmit -> 报文转发
Method (str) - VServer负载均衡的模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）。
MonitorType (str) - 健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；
Path (str) - 根据MonitorType确认；当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查路径
PersistenceInfo (str) - 根据PersistenceType确定： None或ServerInsert，此字段为空； UserDefined，此字段展示用户自定义会话string。
PersistenceType (str) - VServer会话保持方式。枚举值为： None -> 关闭会话保持； ServerInsert -> 自动生成； UserDefined -> 用户自定义。
PolicySet (list) - 见 ULBPolicySet 模型定义
Protocol (str) - VServer实例的协议。枚举值为：HTTP，TCP，UDP，HTTPS。
SSLSet (list) - 见 ULBSSLSet 模型定义
Status (int) - VServer的运行状态。枚举值： 0 -> rs全部运行正常;1 -> rs全部运行异常；2 -> rs部分运行异常。
VServerId (str) - VServer实例的Id
VServerName (str) - VServer实例的名字

ULBIPSet

Bandwidth (int) - 弹性IP的带宽值（暂未对外开放）
BandwidthType (int) - 弹性IP的带宽类型，枚举值：1 表示是共享带宽，0 普通带宽类型（暂未对外开放）
EIP (str) - 弹性IP地址
EIPId (str) - 弹性IP的ID
OperatorName (str) - 弹性IP的运营商信息，枚举值为： Bgp：BGP IP International：国际IP

ULBSet

Bandwidth (int) - 带宽
BandwidthType (int) - 带宽类型，枚举值为： 0，非共享带宽； 1，共享带宽
BusinessId (str) - ULB 所属的业务组ID
CreateTime (int) - ULB的创建时间，格式为Unix Timestamp
ExpireTime (int) - ULB的到期时间，格式为Unix Timestamp
IPSet (list) - 见 ULBIPSet 模型定义
Name (str) - 负载均衡的资源名称（资源系统中），缺省值“ULB”
PrivateIP (str) - ULB的内网IP，当ULBType为OuterMode时，该值为空
Remark (str) - 负载均衡的备注，缺省值“”
Resource (list) - ULB的详细信息列表（废弃）
SubnetId (str) - ULB 为 InnerMode 时，ULB 所属的子网ID，默认为空
Tag (str) - 负载均衡的业务组名称，缺省值“Default”
ULBId (str) - 负载均衡的资源ID
ULBName (str) - 负载均衡的资源名称(内部记载，废弃)
ULBType (str) - ULB 的类型
VPCId (str) - ULB所在的VPC的ID
VServerSet (list) - 见 ULBVServerSet 模型定义

describe_vserver(req=None, **kwargs)[source]¶

DescribeVServer - 获取ULB下的VServer的详细信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ULBId (str) - (Required) 负载均衡实例的Id
Limit (int) - 数据分页值
Offset (int) - 数据偏移量
VServerId (str) - VServer实例的Id；若指定则返回指定的VServer实例的信息；若不指定则返回当前负载均衡实例下所有VServer的信息

Response

DataSet (list) - 见 ULBVServerSet 模型定义
TotalCount (int) - 满足条件的VServer总数

Response Model

PolicyBackendSet

BackendId (str) - 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关
ObjectId (str) - 后端资源的对象ID
Port (int) - 所添加的后端资源服务端口
PrivateIP (str) - 后端资源的内网IP
ResourceName (str) - 后端资源的实例名称

ULBSSLSet

HashValue (str) -
SSLId (str) - SSL证书的Id
SSLName (str) - SSL证书的名字

ULBPolicySet

BackendSet (list) - 见 PolicyBackendSet 模型定义
Match (str) - 内容转发匹配字段;默认内容转发类型下为空。
PolicyId (str) - 内容转发Id，默认内容转发类型下为空。
PolicyPriority (int) - 内容转发优先级，范围[1,9999]，数字越大优先级越高。默认内容转发规则下为0。
PolicyType (str) - 内容类型，枚举值：Custom -> 客户自定义；Default -> 默认内容转发
TotalCount (int) - 默认内容转发类型下返回当前rs总数
Type (str) - 内容转发匹配字段的类型，枚举值：Domain -> 域名；Path -> 路径；默认内容转发类型下为空
VServerId (str) - 所属VServerId

ULBBackendSet

BackendId (str) - 后端资源实例的Id
Enabled (int) - 后端提供服务的实例启用与否，枚举值：0 禁用 1 启用
Port (int) - 后端提供服务的端口
PrivateIP (str) - 后端提供服务的内网IP
ResourceId (str) - 资源实例的资源Id
ResourceName (str) - 资源实例的资源名称
ResourceType (str) - 资源实例的类型
Status (int) - 后端提供服务的实例运行状态，枚举值：0健康检查健康状态 1 健康检查异常
SubResourceId (str) - 资源绑定的虚拟网卡实例的资源Id
SubResourceName (str) - 资源绑定的虚拟网卡实例的资源名称
SubResourceType (str) - 资源绑定的虚拟网卡实例的类型
SubnetId (str) - 后端提供服务的资源所在的子网的ID
Weight (int) -

ULBVServerSet

BackendSet (list) - 见 ULBBackendSet 模型定义
ClientTimeout (int) - 空闲连接的回收时间，单位：秒。
Domain (str) - 根据MonitorType确认；当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查域名
FrontendPort (int) - VServer服务端口
ListenType (str) - 监听器类型，枚举值为: RequestProxy -> 请求代理；PacketsTransmit -> 报文转发
Method (str) - VServer负载均衡的模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）。
MonitorType (str) - 健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；
Path (str) - 根据MonitorType确认；当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查路径
PersistenceInfo (str) - 根据PersistenceType确定： None或ServerInsert，此字段为空； UserDefined，此字段展示用户自定义会话string。
PersistenceType (str) - VServer会话保持方式。枚举值为： None -> 关闭会话保持； ServerInsert -> 自动生成； UserDefined -> 用户自定义。
PolicySet (list) - 见 ULBPolicySet 模型定义
Protocol (str) - VServer实例的协议。枚举值为：HTTP，TCP，UDP，HTTPS。
SSLSet (list) - 见 ULBSSLSet 模型定义
Status (int) - VServer的运行状态。枚举值： 0 -> rs全部运行正常;1 -> rs全部运行异常；2 -> rs部分运行异常。
VServerId (str) - VServer实例的Id
VServerName (str) - VServer实例的名字

release_backend(req=None, **kwargs)[source]¶

ReleaseBackend - 从VServer释放后端资源实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackendId (str) - (Required) 后端资源实例的ID(ULB后端ID，非资源自身ID)
ULBId (str) - (Required) 负载均衡实例的ID

Response

unbind_ssl(req=None, **kwargs)[source]¶

UnbindSSL - 从VServer解绑SSL证书

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SSLId (str) - (Required) SSL证书的Id
ULBId (str) - (Required) 所绑定ULB实例ID
VServerId (str) - (Required) 所绑定VServer实例ID

Response

update_backend_attribute(req=None, **kwargs)[source]¶

UpdateBackendAttribute - 更新ULB后端资源实例(服务节点)属性

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackendId (str) - (Required) 后端资源实例的ID(ULB后端ID，非资源自身ID)
ULBId (str) - (Required) 负载均衡资源ID
Enabled (int) - 后端实例状态开关
Port (int) - 后端资源服务端口，取值范围[1-65535]
Weight (int) - 所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1

Response

update_policy(req=None, **kwargs)[source]¶

UpdatePolicy - 更新内容转发规则，包括转发规则后的服务节点

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackendId (list) - (Required) 内容转发策略应用的后端资源实例的ID，来源于 AllocateBackend 返回的 BackendId
Match (str) - (Required) 内容转发匹配字段
PolicyId (str) - (Required) 转发规则的ID
ULBId (str) - (Required) 需要添加内容转发策略的负载均衡实例ID
VServerId (str) - (Required) 需要添加内容转发策略的VServer实例ID
Type (str) - 内容转发匹配字段的类型

Response

PolicyId (str) - 转发规则的ID

update_ulb_attribute(req=None, **kwargs)[source]¶

UpdateULBAttribute - 更新ULB名字业务组备注等属性字段

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ULBId (str) - (Required) ULB资源ID
Name (str) - 名字
Remark (str) - 备注
Tag (str) - 业务

Response

update_vserver_attribute(req=None, **kwargs)[source]¶

UpdateVServerAttribute - 更新VServer实例属性

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ULBId (str) - (Required) 负载均衡实例ID
VServerId (str) - (Required) VServer实例ID
ClientTimeout (int) - 请求代理的VServer下表示空闲连接的回收时间，单位：秒，取值范围：时(0，86400]，默认值为60；报文转发的VServer下表示回话保持的时间，单位：秒，取值范围：[60，900]，0 表示禁用连接保持
Domain (str) - MonitorType 为 Path 时指定健康检查发送请求时HTTP HEADER 里的域名
Method (str) - VServer负载均衡模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）; WeightRoundrobin -> 加权轮询; Leastconn -> 最小连接数。ConsistentHash，SourcePort，ConsistentHashPort 只在报文转发中使用；Leastconn只在请求代理中使用；Roundrobin、Source和WeightRoundrobin在请求代理和报文转发中使用。默认为：”Roundrobin”
MonitorType (str) - 健康检查的类型，Port:端口,Path:路径
Path (str) - MonitorType 为 Path 时指定健康检查发送请求时的路径，默认为 /
PersistenceInfo (str) - 根据PersistenceType确定: None或ServerInsert, 此字段无意义; UserDefined, 则此字段传入用户自定义会话保持String. 若无此字段则不做修改
PersistenceType (str) - VServer会话保持模式，若无此字段则不做修改。枚举值：None：关闭；ServerInsert：自动生成KEY；UserDefined：用户自定义KEY。
Protocol (str) - VServer协议类型，请求代理只支持修改为 HTTP/HTTPS，报文转发VServer只支持修改为 TCP/UDP
VServerName (str) - VServer实例名称，若无此字段则不做修改

Response

UMem¶

class ucloud.services.umem.client.UMemClient(config, transport=None, middleware=None, logger=None)[source]¶

create_umem_cache_group(req=None, **kwargs)[source]¶

CreateUMemcacheGroup - 创建单机Memcache

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 请求创建组的名称范围[6-60]
ChargeType (str) - 计费模式，Year , Month, Dynamic 默认: Month
ConfigId (str) - 配置ID,目前仅支持默认配置id 默认配置id:”9a891891-c245-4b66-bce8-67e59430d67c”
CouponId (str) - 代金券ID
Protocol (str) -
Quantity (int) - 购买时长，默认为1
Size (int) - 每个节点的内存大小,单位GB,默认1GB 目前仅支持1/2/4/8/16/32这几档
SubnetId (str) -
Tag (str) - 业务组默认：Default
VPCId (str) -
Version (str) - Memcache版本信息,默认为1.4.31
Zone (str) - 可用区。参见可用区列表

Response

GroupId (str) - 创建的组ID

create_umem_space(req=None, **kwargs)[source]¶

CreateUMemSpace - 创建UMem内存空间

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 空间名称,长度(6<=size<=63)
Size (int) - (Required) 内存大小, 单位:GB, 范围[1~1024]
ChargeType (str) - Year , Month, Dynamic, Trial 默认: Month
CouponId (str) - 使用的代金券id
Password (str) - URedis密码。请遵照字段规范设定密码。密码需使用base64进行编码，举例如下：# echo -n Password1 | base64UGFzc3dvcmQx。
Protocol (str) - 协议:memcache, redis (默认redis).注意:redis无single类型
Quantity (int) - 购买时长默认: 1
SubnetId (str) -
Tag (str) -
Type (str) - 空间类型:single(无热备),double(热备)(默认: double)
VPCId (str) -
Zone (str) - 可用区。参见可用区列表

Response

SpaceId (str) - 创建内存空间ID列表

create_uredis_group(req=None, **kwargs)[source]¶

CreateURedisGroup - 创建主备redis

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
HighAvailability (str) - (Required) 是否开启高可用,enable或disable
Name (str) - (Required) 请求创建组的名称 (范围[6-63],只能包含英文、数字以及符号-和_)
Zone (str) - (Required) 可用区。参见可用区列表
AutoBackup (str) - 是否自动备份,enable或disable，默认disable
BackupId (str) - 有此项代表从备份中创建，无代表正常创建
BackupTime (int) - 自动备份开始时间,范围[0-23],默认3点
ChargeType (str) - 计费模式，Year , Month, Dynamic 默认: Month
ConfigId (str) - 配置ID,目前支持 3.0版本配置ID:”03f58ca9-b64d-4bdd-abc7-c6b9a46fd801”,3.2版本配置ID:”3e45ac48-f8a2-a9q2-261d-l342dab130gf”, 4.0版本配置ID:”6c9298a3-9d7f-428c-b1d0-e87ab3b8a1ea”,默认版本3.0,从备份创建为必传项
CouponId (str) - 代金券ID
MasterGroupId (str) - Master Redis Group的ID，创建只读Slave时，必须填写
Password (str) - 初始化密码,需要 base64 编码
Quantity (int) - 购买时长，默认为1
Size (int) - 每个节点的内存大小,单位GB,默认1GB,目前仅支持1/2/4/8/16/32,六种
SlaveZone (str) - 跨机房URedis，slave所在可用区（必须和Zone在同一Region，且不可相同）
SubnetId (str) -
Tag (str) - 业务组名称
VPCId (str) -
Version (str) - Redis版本信息(详见DescribeURedisVersion返回结果),默认版本3.0

Response

GroupId (str) - 创建的组ID

delete_umem_cache_group(req=None, **kwargs)[source]¶

DeleteUMemcacheGroup - 删除单机Memcache

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 组ID
Zone (str) - 可用区。参见可用区列表

Response

delete_umem_space(req=None, **kwargs)[source]¶

DeleteUMemSpace - 删除UMem内存空间

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SpaceId (str) - (Required) UMem内存空间ID
Zone (str) - 可用区。参见可用区列表

Response

delete_uredis_group(req=None, **kwargs)[source]¶

DeleteURedisGroup - 删除主备redis

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 组ID

Response

describe_umem_cache_group(req=None, **kwargs)[source]¶

DescribeUMemcacheGroup - 显示Memcache

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - 组的ID,如果指定则获取描述，否则为列表操作,需指定Offset/Limit
Limit (int) - 分页显示的条目数, 默认值为20
Offset (int) - 分页显示的起始偏移, 默认值为0
Zone (str) - 可用区。参见可用区列表

Response

DataSet (list) - 见 UMemcacheGroupSet 模型定义
TotalCount (int) - 组的总的节点个数

Response Model

UMemcacheGroupSet

ChargeType (str) - 计费类型:Year,Month,Dynamic 默认Dynamic
ConfigId (str) - 节点的配置ID
CreateTime (int) - 创建时间 (UNIX时间戳)
ExpireTime (int) - 过期时间 (UNIX时间戳)
GroupId (str) - 组ID
ModifyTime (int) - 修改时间 (UNIX时间戳)
Name (str) - 组名称
Port (int) - 节点分配的服务端口
Size (int) - 容量单位GB
State (str) - 状态标记 Creating // 初始化中 CreateFail // 创建失败 Deleting // 删除中 DeleteFail // 删除失败 Running // 运行 Resizing // 容量调整中 ResizeFail // 容量调整失败 Configing // 配置中 ConfigFail // 配置失败Restarting // 重启中
SubnetId (str) -
Tag (str) - 业务组名称
UsedSize (int) - 使用量单位MB
VPCId (str) -
Version (str) - Memcache版本信息,默认为1.4.31
VirtualIP (str) - 节点的虚拟IP地址

describe_umem_cache_price(req=None, **kwargs)[source]¶

DescribeUMemcachePrice - 获取umemcache组价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 容量大小,单位:GB 取值范围[1-32]
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - 计费模式，Year， Month， Dynamic，默认: Dynamic 默认: 获取所有计费模式的价格
Quantity (int) - 购买umemcache的时长，默认值为1
Type (str) - 空间类型:single(无热备),double(热备)(默认: double)

Response

DataSet (list) - 见 UMemcachePriceSet 模型定义

Response Model

UMemcachePriceSet

ChargeType (str) - 计费模式，Year, Month, Dynamic
OriginalPrice (int) - 原价
Price (int) - 总价格，单位: 元，保留小数点后两位有效数字

describe_umem_cache_upgrade_price(req=None, **kwargs)[source]¶

DescribeUMemcacheUpgradePrice - 获取umemcache升级价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 需要升级的空间的GroupId,请参考DescribeUMemcacheGroup接口
Size (int) - (Required) 购买umemcache大小,单位:GB
Zone (str) - 可用区。参见可用区列表

Response

DataSet (dict) - 见 PriceDataSet 模型定义
Price (int) - 价格，单位：元

Response Model

PriceDataSet

CustomPrice (int) - 用户折后价
PurchaseValue (int) - 资源有效期
TotalPrice (int) - 升降级资源的价格

describe_umem_price(req=None, **kwargs)[source]¶

DescribeUMemPrice - 获取UMem实例价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 购买umem大小,单位:GB,范围[1~1024]
Type (str) - (Required) 空间类型:single(无热备),double(热备)(默认: double)
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year， Month， Dynamic，Trial 如果不指定，则一次性获取三种计费
Quantity (int) - 购买UMem的时长，默认值为1
RegionFlag (bool) -

Response

DataSet (list) - 见 UMemPriceSet 模型定义

Response Model

UMemPriceSet

ChargeType (str) - Year， Month， Dynamic，Trial
OriginalPrice (int) - 原价
Price (int) - 现价，单位: 元，保留小数点后两位有效数字

describe_umem_space(req=None, **kwargs)[source]¶

DescribeUMemSpace - 获取UMem内存空间列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 返回数据长度, 默认为20
Offset (int) - 数据偏移量, 默认为0
SpaceId (str) - 内存空间ID (无ID，则获取所有)
Zone (str) - 可用区。参见可用区列表

Response

DataSet (list) - 见 UMemSpaceSet 模型定义
TotalCount (int) - 根据过滤条件得到的总数

Response Model

UMemSpaceAddressSet

IP (str) - UMem实例访问IP
Port (int) - UMem实例访问Port

UMemSpaceSet

Address (list) - 见 UMemSpaceAddressSet 模型定义
ChargeType (str) - Year, Month, Dynamic, Trial
CreateTime (int) - 创建时间
ExpireTime (int) - 到期时间
Name (str) - 内存空间名称
Protocol (str) - 协议类型: memcache, redis
RewriteTime (int) - 运维时间0 //0点1 //1点依次类推
Size (int) - 容量单位GB
SpaceId (str) - 内存空间ID
State (str) - Starting:创建中 Running:运行中 Fail:失败
SubnetId (str) -
Tag (str) -
Type (str) - 空间类型:single(无热备),double(热备)
UsedSize (int) - 使用量单位MB
VPCId (str) -
Zone (str) - 可用区，参见可用区列表

describe_umem_upgrade_price(req=None, **kwargs)[source]¶

DescribeUMemUpgradePrice - 获取UMem升级价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 购买UMem大小,单位:GB
SpaceId (str) - (Required) 需要升级的空间的SpaceId
Type (str) - (Required) 空间类型:single(无热备),double(热备)(默认: double)
Zone (str) - 可用区。参见可用区列表

Response

DataSet (dict) - 见 PriceDataSet 模型定义
Price (int) - 价格(兼容老版本)

Response Model

PriceDataSet

CustomPrice (int) - 用户折后价
PurchaseValue (int) - 资源有效期
TotalPrice (int) - 升降级资源的价格

describe_uredis_backup(req=None, **kwargs)[source]¶

DescribeURedisBackup - 查询主备redis备份

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - 组的ID
Limit (int) - 分页显示的条目数, 默认值为10
Offset (int) - 分页显示的起始偏移, 默认值为0

Response

DataSet (list) - 见 URedisBackupSet 模型定义
TotalCount (int) - 用户名下总的备份个数

Response Model

URedisBackupSet

BackupId (str) - 备份ID
BackupName (str) - 备份的名称
BackupSize (int) - 备份文件大小, 以字节为单位
BackupTime (int) - 备份时间 (UNIX时间戳)
BackupType (str) - 备份类型: Manual 手动 Auto 自动
GroupId (str) - 对应的实例ID
GroupName (str) - 组名称
State (str) - 备份的状态: Backuping 备份中 Success 备份成功 Error 备份失败 Expired 备份过期
Zone (str) - 可用区，参见可用区列表

describe_uredis_backup_url(req=None, **kwargs)[source]¶

DescribeURedisBackupURL - 获取主备Redis备份下载链接

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupId (str) - (Required) 备份ID
GroupId (str) - 实例名称
RegionFlag (bool) - 是否是跨机房URedis(默认false)
Zone (str) - 可用区。参见可用区列表

Response

BackupPath (str) - 备份文件公网的地址
BackupURL (str) - 备份文件公网的地址
InnerBackupPath (str) -

describe_uredis_group(req=None, **kwargs)[source]¶

DescribeURedisGroup - 查询主备Redis

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - 组的ID,如果指定则获取描述，否则为列表操作,需指定Offset/Limit
Limit (int) - 分页显示的条目数, 默认值为20
Offset (int) - 分页显示的起始偏移, 默认值为0
Zone (str) -

Response

DataSet (list) - 见 URedisGroupSet 模型定义
TotalCount (int) - 组的总的节点个数

Response Model

URedisGroupSet

AutoBackup (str) - 是否需要自动备份,enable,disable
BackupTime (int) - 组自动备份开始时间,单位小时计,范围[0-23]
ChargeType (str) - 计费类型:Year,Month,Dynamic 默认Dynamic
ConfigId (str) - 节点的配置ID
CreateTime (int) - 创建时间 (UNIX时间戳)
ExpireTime (int) - 过期时间 (UNIX时间戳)
GroupId (str) - 组ID
GroupName (str) - 组名称
HighAvailability (str) - 是否开启高可用,enable,disable
MemorySize (int) - 容量单位GB
ModifyTime (int) - 修改时间 (UNIX时间戳)
Name (str) - 组名称
Port (int) - 节点分配的服务端口
Protocol (str) - 协议
RewriteTime (int) - 返回运维时间 0 //0点 1 //1点以此类推
Size (int) - 容量单位GB
SlaveZone (str) - 跨机房URedis，slave redis所在可用区，参见可用区列表
State (str) - 状态标记 Creating // 初始化中 CreateFail // 创建失败 Deleting // 删除中 DeleteFail // 删除失败 Running // 运行 Resizing // 容量调整中 ResizeFail // 容量调整失败 Configing // 配置中 ConfigFail // 配置失败
SubnetId (str) -
Tag (str) - 业务组名称
Type (str) -
UsedSize (int) - 使用量单位MB
VPCId (str) -
Version (str) - Redis版本信息
VirtualIP (str) - 节点的虚拟IP地址
Zone (str) - 实例所在可用区，或者master redis所在可用区，参见可用区列表

describe_uredis_price(req=None, **kwargs)[source]¶

DescribeURedisPrice - 取uredis价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 量大小,单位:GB 取值范围[1-32]
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - 计费模式，Year， Month， Dynamic；如果不指定，则一次性获取三种计费
ProductType (str) - 产品类型：MS_Redis（标准主备版），S_Redis（从库），默认为MS_Redis
Quantity (int) - 计费模式为Dynamic时，购买的时长, 默认为1
RegionFlag (bool) - 是否是跨机房URedis(默认false)
Type (str) -

Response

DataSet (list) - 见 URedisPriceSet 模型定义

Response Model

URedisPriceSet

ChargeType (str) - Year， Month， Dynamic，Trial
OriginalPrice (int) - 原价
Price (int) - 总价格，单位: 元，保留小数点后两位有效数字

describe_uredis_upgrade_price(req=None, **kwargs)[source]¶

DescribeURedisUpgradePrice - 获取uredis升级价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 要升级的空间的GroupId,请参考DescribeURedisGroup接口
Size (int) - (Required) 购买uredis大小,单位:GB,范围是[1-32]
Type (str) -
Zone (str) - 可用区。参见可用区列表

Response

DataSet (dict) - 见 PriceDataSet 模型定义
Price (int) - 扩容差价，单位: 元，保留小数点后两位有效数字(兼容老版本)

Response Model

PriceDataSet

CustomPrice (int) - 用户折后价
PurchaseValue (int) - 资源有效期
TotalPrice (int) - 升降级资源的价格

get_umem_space_state(req=None, **kwargs)[source]¶

GetUMemSpaceState - 获取UMem内存空间列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SpaceId (str) - (Required) 内存空间ID
Zone (str) - 可用区。参见可用区列表

Response

State (str) - Starting:创建中 Running:运行中 Fail:失败

modify_umem_space_name(req=None, **kwargs)[source]¶

ModifyUMemSpaceName - 修改UMem内存空间名称

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 新的名称,长度(6<=size<=63)
SpaceId (str) - (Required) UMem内存空间ID
Zone (str) - 可用区。参见可用区列表

Response

modify_uredis_group_name(req=None, **kwargs)[source]¶

ModifyURedisGroupName - 修改主备redis名称

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 组的ID
Name (str) - (Required) Redis组名称 (范围[6-63],只能包含英文、数字以及符号-和_)
Zone (str) - 可用区。参见可用区列表

Response

resize_udredis_space(req=None, **kwargs)[source]¶

ResizeUDredisSpace - 调整内存空间容量

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 内存大小, 单位:GB (需要大于原size,<= 1024)
SpaceId (str) - (Required) 高性能UMem 内存空间Id
CouponId (str) - 使用的代金券Id
Zone (str) - 可用区。参见可用区列表

Response

resize_umem_space(req=None, **kwargs)[source]¶

ResizeUMemSpace - 调整内存空间容量

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 内存大小, 单位:GB (需要大于原size,<= 1024)
SpaceId (str) - (Required) UMem 内存空间Id
ChargeType (str) -
CouponId (str) - 使用的代金券Id
Type (str) - 空间类型:single(无热备),double(热备)(默认: double)
Zone (str) - 可用区。参见可用区列表

Response

resize_uredis_group(req=None, **kwargs)[source]¶

ResizeURedisGroup - 调整主备redis容量

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 组ID
Size (int) - (Required) 内存大小, 单位:GB (需要大于原size,且小于等于32) 目前仅支持1/2/4/8/16/32 G 六种容量规格
ChargeType (str) -
CouponId (int) - 代金券ID 请参考DescribeCoupon接口
Type (str) - 空间类型:single(无热备),double(热备)(默认: double)
Zone (str) - 可用区。参见可用区列表

Response

restart_umem_cache_group(req=None, **kwargs)[source]¶

RestartUMemcacheGroup - 重启单机Memcache

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 组的ID
Zone (str) - 可用区。参见可用区列表

Response

UNet¶

class ucloud.services.unet.client.UNetClient(config, transport=None, middleware=None, logger=None)[source]¶

allocate_eip(req=None, **kwargs)[source]¶

AllocateEIP - 根据提供信息, 申请弹性IP

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。
Region (str) - (Config) 地域。
Bandwidth (int) - (Required) 弹性IP的外网带宽, 单位为Mbps. 共享带宽模式必须指定0M带宽, 非共享带宽模式必须指定非0Mbps带宽. 各地域非共享带宽的带宽范围如下：流量计费[1-200]，带宽计费[1-800]
OperatorName (str) - (Required) 弹性IP的线路如下: 国际: International BGP: Bgp 各地域允许的线路参数如下: cn-sh1: Bgp cn-sh2: Bgp cn-gd: Bgp cn-bj1: Bgp cn-bj2: Bgp hk: International us-ca: International th-bkk: International kr-seoul:International us-ws:International ge-fra:International sg:International tw-kh:International.其他海外线路均为 International
ChargeType (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费; Dynamic, 按需付费(需开启权限); Trial, 试用(需开启权限) 默认为按月付费
CouponId (str) - 代金券ID, 默认不使用
Name (str) - 弹性IP的名称, 默认为 “EIP”
PayMode (str) - 弹性IP的计费模式. 枚举值: “Traffic”, 流量计费; “Bandwidth”, 带宽计费; “ShareBandwidth”,共享带宽模式. 默认为 “Bandwidth”.
Quantity (int) - 购买时长, 默认: 1
Remark (str) - 弹性IP的备注, 默认为空
ShareBandwidthId (str) - 绑定的共享带宽Id，仅当PayMode为ShareBandwidth时有效
Tag (str) - 业务组名称, 默认为 “Default”

Response

EIPSet (list) - 见 UnetAllocateEIPSet 模型定义

Response Model

UnetEIPAddrSet

IP (str) - IP地址
OperatorName (str) - 运营商信息如: 电信: Telecom, 联通: Unicom, 国际: International, Duplet: 双线IP（电信+联通), BGP: Bgp

UnetAllocateEIPSet

EIPAddr (list) - 见 UnetEIPAddrSet 模型定义
EIPId (str) - 申请到的EIP资源ID

allocate_share_bandwidth(req=None, **kwargs)[source]¶

AllocateShareBandwidth - 开通共享带宽

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。
Region (str) - (Config) 地域。参见地域和可用区列表
ChargeType (str) - (Required) 付费方式:Year 按年,Month 按月,Dynamic 按时;
Name (str) - (Required) 共享带宽名字
ShareBandwidth (int) - (Required) 共享带宽值
BwType (str) - 共享带宽类型，ipv4或者ipv6，不传默认ipv4
Quantity (int) - 购买时长
ShareBandwidthGuarantee (int) - 共享带宽保底值(后付费)

Response

ShareBandwidthId (str) - 共享带宽资源Id

allocate_vip(req=None, **kwargs)[source]¶

AllocateVIP - 根据提供信息，申请内网VIP(Virtual IP），多用于高可用程序作为漂移IP。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域
SubnetId (str) - (Required) 子网id
VPCId (str) - (Required) 指定vip所属的VPC
BusinessId (str) - 业务组
Count (int) - 申请数量，默认: 1
Ip (str) - 指定ip
Name (str) - vip名，默认为VIP
Remark (str) - 备注
Tag (str) - 业务组名称，默认为Default
Zone (str) - 可用区

Response

DataSet (list) - 申请到的VIP地址
VIPSet (list) - 见 VIPSet 模型定义

Response Model

VIPSet

VIP (str) - 虚拟ip
VIPId (str) - 虚拟ip id
VPCId (str) - VPC id

associate_eip_with_share_bandwidth(req=None, **kwargs)[source]¶

AssociateEIPWithShareBandwidth - 将EIP加入共享带宽

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。
Region (str) - (Config) 地域。
EIPIds (list) - (Required) 要加入共享带宽的EIP的资源Id
ShareBandwidthId (str) - (Required) 共享带宽ID

Response

bind_eip(req=None, **kwargs)[source]¶

BindEIP - 将尚未使用的弹性IP绑定到指定的资源

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写
Region (str) - (Config) 地域
EIPId (str) - (Required) 弹性IP的资源Id
ResourceId (str) - (Required) 弹性IP请求绑定的资源ID
ResourceType (str) - (Required) 弹性IP请求绑定的资源类型, 枚举值为: uhost: 云主机; ulb, 负载均衡器 upm: 物理机; hadoophost: 大数据集群;fortresshost：堡垒机；udockhost：容器；udhost：私有专区主机；natgw：natgw；udb：udb；vpngw：ipsec vpn；ucdr：云灾备；dbaudit：数据库审计；uni：虚拟网卡。

Response

create_bandwidth_package(req=None, **kwargs)[source]¶

CreateBandwidthPackage - 为非共享带宽模式下, 已绑定资源实例的带宽计费弹性IP附加临时带宽包

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。
Region (str) - (Config) 地域
Bandwidth (int) - (Required) 带宽大小(单位Mbps), 取值范围[2,800] (最大值受地域限制)
EIPId (str) - (Required) 所绑定弹性IP的资源ID
TimeRange (int) - (Required) 带宽包有效时长, 取值范围为大于0的整数, 即该带宽包在EnableTime到 EnableTime+TimeRange时间段内生效
CouponId (str) - 代金券ID
EnableTime (int) - 生效时间, 格式为 Unix timestamp, 默认为立即开通

Response

BandwidthPackageId (str) - 所创建带宽包的资源ID

create_firewall(req=None, **kwargs)[source]¶

CreateFirewall - 创建防火墙

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写
Region (str) - (Config) 地域
Name (str) - (Required) 防火墙名称
Rule (list) - (Required) 防火墙规则，例如：TCP|22|192.168.1.1/22|DROP|LOW|禁用22端口，第一个参数代表协议：第二个参数代表端口号，第三个参数为ip，第四个参数为ACCEPT（接受）和DROP（拒绝），第五个参数优先级：HIGH（高），MEDIUM（中），LOW（低），第六个参数为该条规则的自定义备注
Remark (str) - 防火墙描述，默认为空
Tag (str) - 防火墙业务组，默认为Default

Response

FWId (str) - 防火墙ID

delete_bandwidth_package(req=None, **kwargs)[source]¶

DeleteBandwidthPackage - 删除弹性IP上已附加带宽包

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写
Region (str) - (Config) 地域
BandwidthPackageId (str) - (Required) 带宽包资源ID

Response

delete_firewall(req=None, **kwargs)[source]¶

DeleteFirewall - 删除防火墙

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写
Region (str) - (Config) 地域
FWId (str) - (Required) 防火墙资源ID

Response

describe_bandwidth_package(req=None, **kwargs)[source]¶

DescribeBandwidthPackage - 获取某地域下的带宽包信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 返回数据分页值, 取值范围为 [0,10000000] 之间的整数, 默认为20
Offset (int) - 返回数据偏移量, 默认为0

Response

DataSets (list) - 见 UnetBandwidthPackageSet 模型定义
TotalCount (int) - 满足条件的带宽包总数

Response Model

EIPAddrSet

IP (str) - 弹性IP地址
OperatorName (str) - 运营商信息, 枚举值为: Telecom 电信; Unicom: 联通; Duplet: 双线; Bgp: BGP; International: 国际.

UnetBandwidthPackageSet

Bandwidth (int) - 带宽包的临时带宽值, 单位Mbps
BandwidthPackageId (str) - 带宽包的资源ID
CreateTime (int) - 创建时间, 格式为 Unix Timestamp
DisableTime (int) - 失效时间, 格式为 Unix Timestamp
EIPAddr (list) - 见 EIPAddrSet 模型定义
EIPId (str) - 带宽包所绑定弹性IP的资源ID
EnableTime (int) - 生效时间, 格式为 Unix Timestamp

describe_bandwidth_usage(req=None, **kwargs)[source]¶

DescribeBandwidthUsage - 获取带宽用量信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EIPIds (list) - 弹性IP的资源Id. 如果为空, 则返回当前 Region中符合条件的所有EIP的带宽用量, n为自然数
Limit (int) - 返回数据分页值, 取值范围为 [0,10000000] 之间的整数, 默认为20
OffSet (int) - 返回数据偏移量, 默认为0

Response

EIPSet (list) - 见 UnetBandwidthUsageEIPSet 模型定义
TotalCount (int) - EIPSet中的元素个数

Response Model

UnetBandwidthUsageEIPSet

CurBandwidth (float) - 最近5分钟带宽用量, 单位Mbps
EIPId (str) - 弹性IP资源ID

describe_eip(req=None, **kwargs)[source]¶

DescribeEIP - 获取弹性IP信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写
Region (str) - (Config) 地域
EIPIds (list) - 弹性IP的资源ID如果为空, 则返回当前 Region中符合条件的的所有EIP
Limit (int) - 数据分页值, 默认为20
Offset (int) - 数据偏移量, 默认为0

Response

EIPSet (list) - 见 UnetEIPSet 模型定义
TotalBandwidth (int) - 满足条件的弹性IP带宽总和, 单位Mbps
TotalCount (int) - 满足条件的弹性IP总数

Response Model

ShareBandwidthSet

ShareBandwidth (int) - 共享带宽带宽值
ShareBandwidthId (str) - 共享带宽ID
ShareBandwidthName (str) - 共享带宽的资源名称

UnetEIPAddrSet

IP (str) - IP地址
OperatorName (str) - 运营商信息如: 电信: Telecom, 联通: Unicom, 国际: International, Duplet: 双线IP（电信+联通), BGP: Bgp

UnetEIPResourceSet

EIPId (str) - 弹性IP的资源ID
ResourceId (str) - 已绑定资源的资源ID
ResourceName (str) - 已绑定的资源名称
ResourceType (str) - 已绑定的资源类型, 枚举值为: uhost, 云主机；natgw：NAT网关；ulb：负载均衡器；upm: 物理机; hadoophost: 大数据集群;fortresshost：堡垒机；udockhost：容器；udhost：私有专区主机；vpngw：IPSec VPN；ucdr：云灾备；dbaudit：数据库审计，uni：虚拟网卡。
SubResourceId (str) - 资源绑定的虚拟网卡的ID
SubResourceName (str) - 资源绑定的虚拟网卡的名称
SubResourceType (str) - 资源绑定的虚拟网卡的类型。uni，虚拟网卡。

UnetEIPSet

Bandwidth (int) - 弹性IP的带宽, 单位为Mbps, 当BandwidthType=1时, 该处显示为共享带宽值. 当BandwidthType=0时, 该处显示这个弹性IP的带宽.
BandwidthType (int) - 带宽模式, 枚举值为: 0: 非共享带宽模式, 1: 共享带宽模式
ChargeType (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费; Dynamic, 按小时付费; Trial, 试用. 按小时付费和试用这两种付费模式需要开通权限.
CreateTime (int) - 弹性IP的创建时间, 格式为Unix Timestamp
EIPAddr (list) - 见 UnetEIPAddrSet 模型定义
EIPId (str) - 弹性IP的资源ID
Expire (bool) - 弹性IP是否到期
ExpireTime (int) - 弹性IP的到期时间, 格式为Unix Timestamp
Name (str) - 弹性IP的名称,缺省值为 “EIP”
PayMode (str) - 弹性IP的计费模式, 枚举值为: “Bandwidth”, 带宽计费; “Traffic”, 流量计费; “ShareBandwidth”,共享带宽模式. 默认为 “Bandwidth”.
Remark (str) - 弹性IP的备注, 缺省值为 “”
Resource (dict) - 见 UnetEIPResourceSet 模型定义
ShareBandwidthSet (dict) - 见 ShareBandwidthSet 模型定义
Status (str) - 弹性IP的资源绑定状态, 枚举值为: used: 已绑定, free: 未绑定, freeze: 已冻结
Tag (str) - 弹性IP的业务组标识, 缺省值为 “Default”
Weight (int) - 外网出口权重, 默认为50, 范围[0-100]

describe_firewall(req=None, **kwargs)[source]¶

DescribeFirewall - 获取防火墙组信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写
Region (str) - (Config) 地域
FWId (str) - 防火墙ID，默认为返回所有防火墙
Limit (int) - 返回数据长度，默认为20，最大10000000
Offset (int) - 列表起始位置偏移量，默认为0
ResourceId (str) - 绑定防火墙组的资源ID
ResourceType (str) - 绑定防火墙组的资源类型，默认为全部资源类型。枚举值为：”unatgw”，NAT网关； “uhost”，云主机； “upm”，物理云主机； “hadoophost”，hadoop节点； “fortresshost”，堡垒机； “udhost”，私有专区主机；”udockhost”，容器；”dbaudit”，数据库审计.

Response

DataSet (list) - 见 FirewallDataSet 模型定义
TotalCount (int) -

Response Model

FirewallRuleSet

DstPort (str) - 目标端口
Priority (str) - 优先级
ProtocolType (str) - 协议类型
Remark (str) - 防火墙规则备注
RuleAction (str) - 防火墙动作
SrcIP (str) - 源地址

FirewallDataSet

CreateTime (int) - 防火墙组创建时间，格式为Unix Timestamp
FWId (str) - 防火墙ID
GroupId (str) - 安全组ID（即将废弃）
Name (str) - 防火墙名称
Remark (str) - 防火墙备注
ResourceCount (int) - 防火墙绑定资源数量
Rule (list) - 见 FirewallRuleSet 模型定义
Tag (str) - 防火墙业务组
Type (str) - 防火墙组类型，枚举值为： “user defined”, 用户自定义防火墙； “recommend web”, 默认Web防火墙； “recommend non web”, 默认非Web防火墙

describe_firewall_resource(req=None, **kwargs)[source]¶

DescribeFirewallResource - 获取防火墙组所绑定资源的外网IP

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
FWId (str) - (Required) 防火墙ID
Limit (int) - 返回数据长度，默认为20，最大10000000
Offset (int) - 列表起始位置偏移量，默认为0

Response

ResourceSet (list) - 见 ResourceSet 模型定义
TotalCount (int) - 绑定资源总数

Response Model

ResourceSet

Name (str) - 名称
PrivateIP (str) - 内网IP
Remark (str) - 备注
ResourceID (str) - 绑定该防火墙的资源id
ResourceType (str) - 绑定资源的资源类型，如”uhost”,”upm”,”umem”,”uhive”,”uvip”,”uredis”,”uhadoop”,”ufortress”,”dbaudit”,”udw”,”udocker”, “umemcache”
Status (int) - 状态
Tag (str) - 业务组
Zone (int) - 可用区

describe_share_bandwidth(req=None, **kwargs)[source]¶

DescribeShareBandwidth - 获取共享带宽信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ShareBandwidthIds (list) - 需要返回的共享带宽Id

Response

DataSet (list) - 见 UnetShareBandwidthSet 模型定义
TotalCount (int) - 符合条件的共享带宽总数，大于等于返回DataSet长度

Response Model

EIPAddrSet

IP (str) - 弹性IP地址
OperatorName (str) - 运营商信息, 枚举值为: Telecom 电信; Unicom: 联通; Duplet: 双线; Bgp: BGP; International: 国际.

EIPSetData

Bandwidth (int) - EIP带宽值
EIPAddr (list) - 见 EIPAddrSet 模型定义
EIPId (str) - EIP资源Id

UnetShareBandwidthSet

BandwidthGuarantee (int) - 共享带宽保底值(后付费)
ChargeType (str) - 付费方式, 预付费:Year 按年,Month 按月,Dynamic 按需;后付费:PostPay(按月)
CreateTime (int) - 创建时间, 格式为Unix Timestamp
EIPSet (list) - 见 EIPSetData 模型定义
ExpireTime (int) - 过期时间, 格式为Unix Timestamp
Name (str) - 共享带宽名称
PostPayStartTime (int) - 共享带宽后付费开始计费时间(后付费)
ShareBandwidth (int) - 共享带宽值(预付费)/共享带宽峰值(后付费), 单位Mbps
ShareBandwidthId (str) - 共享带宽的资源ID

describe_vip(req=None, **kwargs)[source]¶

DescribeVIP - 获取内网VIP详细信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BusinessId (str) - 业务组
SubnetId (str) - 子网id，不指定则获取VPCId下的所有vip
Tag (str) - 业务组名称, 默认为 Default
VPCId (str) - vpc的id,指定SubnetId时必填
Zone (str) - 可用区。参见可用区列表

Response

DataSet (list) - 内网VIP地址列表
TotalCount (int) - vip数量
VIPSet (list) - 见 VIPDetailSet 模型定义

Response Model

VIPDetailSet

CreateTime (int) - 创建时间
Name (str) -
RealIp (str) - 真实主机ip
SubnetId (str) - 子网id
VIP (str) - 虚拟ip
VIPId (str) - 虚拟ip id
VPCId (str) - VPC id
Zone (str) - 地域

disassociate_eip_with_share_bandwidth(req=None, **kwargs)[source]¶

DisassociateEIPWithShareBandwidth - 将EIP移出共享带宽

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Bandwidth (int) - (Required) 移出共享带宽后，EIP的外网带宽, 单位为Mbps. 各地域带宽范围如下：流量计费[1-200],带宽计费[1-800]
ShareBandwidthId (str) - (Required) 共享带宽ID
EIPIds (list) - EIP的资源Id；默认移出该共享带宽下所有的EIP
PayMode (str) - 移出共享带宽后，EIP的计费模式. 枚举值: “Traffic”, 流量计费; “Bandwidth”, 带宽计费; 默认为 “Bandwidth”.

Response

get_eip_pay_mode(req=None, **kwargs)[source]¶

GetEIPPayMode - 获取弹性IP计费模式

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写
Region (str) - (Config) 地域
EIPId (list) - (Required) 弹性IP的资源Id

Response

EIPPayMode (list) - 见 EIPPayModeSet 模型定义

Response Model

EIPPayModeSet

EIPId (str) - EIP的资源ID
EIPPayMode (str) - EIP的计费模式. 枚举值为：Bandwidth, 带宽计费;Traffic, 流量计费; “ShareBandwidth”,共享带宽模式

get_eip_price(req=None, **kwargs)[source]¶

GetEIPPrice - 获取弹性IP价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Bandwidth (int) - (Required) 弹性IP的外网带宽, 单位为Mbps, 范围 [0-800]
OperatorName (str) - (Required) 弹性IP的线路如下: 国际: International BGP: Bgp 各地域允许的线路参数如下: cn-sh1: Bgp cn-sh2: Bgp cn-gd: Bgp cn-bj1: Bgp cn-bj2: Bgp hk: International us-ca: International th-bkk: International kr-seoul:International us-ws:International ge-fra:International sg:International tw-kh:International.其他海外线路均为 International,泉州为移动单线cn-qz:ChinaMobile
ChargeType (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费; Dynamic, 按时付费; 默认为获取三种价格
PayMode (str) - 弹性IP计费方式r. 枚举值为: Traffic, 流量计费; Bandwidth, 带宽计费; “ShareBandwidth”,共享带宽模式. 默认为Bandwidth
Quantity (int) - 购买时长。默认: 1。按小时购买(Dynamic)时无需此参数。月付时，此参数传0，代表了购买至月末

Response

PriceSet (list) - 见 EIPPriceDetailSet 模型定义

Response Model

EIPPriceDetailSet

ChargeType (str) - 弹性IP付费方式
Price (float) - 弹性IP价格, 单位”元”
PurchaseValue (int) - 资源有效期, 以Unix Timestamp表示

get_eip_upgrade_price(req=None, **kwargs)[source]¶

GetEIPUpgradePrice - 获取弹性IP带宽改动价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Bandwidth (int) - (Required) 弹性IP的外网带宽, 单位为Mbps, 范围 [1-800]
EIPId (str) - (Required) 弹性IP的资源ID

Response

Price (float) - 调整带宽后的EIP价格, 单位为”元”, 如需退费此处为负值

grant_firewall(req=None, **kwargs)[source]¶

GrantFirewall - 将防火墙应用到资源上

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
FWId (str) - (Required) 防火墙资源ID
ResourceId (str) - (Required) 所应用资源ID
ResourceType (str) - (Required) 绑定防火墙组的资源类型，默认为全部资源类型。枚举值为：”unatgw”，NAT网关； “uhost”，云主机； “upm”，物理云主机； “hadoophost”，hadoop节点； “fortresshost”，堡垒机； “udhost”，私有专区主机；”udockhost”，容器；”dbaudit”，数据库审计，”uni“，虚拟网卡。

Response

modify_eip_bandwidth(req=None, **kwargs)[source]¶

ModifyEIPBandwidth - 调整弹性IP的外网带宽

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Bandwidth (int) - (Required) 弹性IP的外网带宽, 单位为Mbps. 各地域的带宽值范围如下：流量计费[1-200],带宽计费[1-800]
EIPId (str) - (Required) 弹性IP的资源ID

Response

modify_eip_weight(req=None, **kwargs)[source]¶

ModifyEIPWeight - 修改弹性IP的外网出口权重

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EIPId (str) - (Required) 弹性IP的资源ID
Weight (int) - (Required) 外网出口权重, 范围[0-100] 取值为0时, 该弹性IP不会被使用. 取值为100时, 同主机下只会使用这个弹性IP，其他弹性IP不会被使用请勿将多个绑定在同一资源的弹性IP设置为相同权重

Response

release_eip(req=None, **kwargs)[source]¶

ReleaseEIP - 释放弹性IP资源, 所释放弹性IP必须为非绑定状态.

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EIPId (str) - (Required) 弹性IP的资源ID

Response

release_share_bandwidth(req=None, **kwargs)[source]¶

ReleaseShareBandwidth - 关闭共享带宽

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EIPBandwidth (int) - (Required) 关闭共享带宽后，各EIP恢复为的带宽值
ShareBandwidthId (str) - (Required) 共享带宽ID
PayMode (str) - Bandwidth 带宽计费, Traffic 转流量计费

Response

release_vip(req=None, **kwargs)[source]¶

ReleaseVIP - 释放VIP资源

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写
Region (str) - (Config) 地域
VIPId (str) - (Required) 内网VIP的id
Zone (str) - 可用区

Response

resize_share_bandwidth(req=None, **kwargs)[source]¶

ResizeShareBandwidth - 调整共享带宽的带宽值

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ShareBandwidth (int) - (Required) 带宽值，单位为Mb，范围 [20-5000] (最大值受地域限制)
ShareBandwidthId (str) - (Required) 共享带宽的Id

Response

set_eip_pay_mode(req=None, **kwargs)[source]¶

SetEIPPayMode - 设置弹性IP计费模式, 切换时会涉及付费/退费.

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Bandwidth (int) - (Required) 调整的目标带宽值, 单位Mbps. 各地域的带宽值范围如下: 流量计费[1-200],其余情况[1-800]
EIPId (str) - (Required) 弹性IP的资源Id
PayMode (str) - (Required) 计费模式. 枚举值：”Traffic”, 流量计费模式; “Bandwidth”, 带宽计费模式

Response

un_bind_eip(req=None, **kwargs)[source]¶

UnBindEIP - 将弹性IP从资源上解绑

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EIPId (str) - (Required) 弹性IP的资源Id
ResourceId (str) - (Required) 弹性IP请求解绑的资源ID
ResourceType (str) - (Required) 弹性IP请求解绑的资源类型, 枚举值为: uhost: 云主机; ulb, 负载均衡器 upm: 物理机; hadoophost: 大数据集群;fortresshost：堡垒机；udockhost：容器；udhost：私有专区主机；natgw：NAT网关；udb：udb；vpngw：ipsec vpn；ucdr：云灾备；dbaudit：数据库审计；uni，虚拟网卡。

Response

update_eip_attribute(req=None, **kwargs)[source]¶

UpdateEIPAttribute - 更新弹性IP名称，业务组，备注等属性字段

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EIPId (str) - (Required) EIP资源ID
Name (str) - 名字（Name Tag Remark都为空则报错）
Remark (str) - 备注
Tag (str) - 业务

Response

update_firewall(req=None, **kwargs)[source]¶

UpdateFirewall - 更新防火墙规则

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
FWId (str) - (Required) 防火墙资源ID
Rule (list) - (Required) 防火墙规则，例如：TCP|22|192.168.1.1/22|DROP|LOW|禁用22端口，第一个参数代表协议：第二个参数代表端口号，第三个参数为ip，第四个参数为ACCEPT（接受）和DROP（拒绝），第五个参数优先级：HIGH（高），MEDIUM（中），LOW（低），第六个参数为该条规则的自定义备注

Response

FWId (str) - 防火墙id

update_firewall_attribute(req=None, **kwargs)[source]¶

UpdateFirewallAttribute - 更新防火墙规则

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
FWId (str) - (Required) 防火墙资源ID
Name (str) - 防火墙名称，默认为空，为空则不做修改。Name,Tag,Remark必须填写1个及以上
Remark (str) - 防火墙备注，默认为空，为空则不做修改。Name,Tag,Remark必须填写1个及以上
Tag (str) - 防火墙业务组，默认为空，为空则不做修改。Name,Tag,Remark必须填写1个及以上

Response

UPHost¶

class ucloud.services.uphost.client.UPHostClient(config, transport=None, middleware=None, logger=None)[source]¶

create_phost(req=None, **kwargs)[source]¶

CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ImageId (str) - (Required) 镜像ID。请通过 [DescribePHostImage]获取
Password (str) - (Required) 密码（密码需使用base64进行编码）
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - 计费模式，枚举值为：year, 按年付费； month,按月付费；dynamic，按需付费，（需开启权限） trial, 试用（需开启权限）。默认为按月付费
Cluster (str) - 网络环境，可选千兆：1G ，万兆：10G，默认1G
Count (int) - 购买数量，默认为1，（暂不支持）
CouponId (str) - 代金券
Name (str) - 物理机名称，默认为phost
Quantity (str) - 购买时长，默认为1，范围[1-10]
Raid (str) - Raid配置，默认Raid10 支持:Raid0、Raid1、Raid5、Raid10，NoRaid
Remark (str) - 物理机备注，默认为空
SecurityGroupId (str) - 防火墙Id，默认：Web推荐防火墙。如何查询SecurityGroupId请参见 DescribeSecurityGroup
SubnetId (str) - 子网ID，不填为默认，VPC2.0下需要填写此字段。
Tag (str) - 业务组，默认为default
Type (str) - 物理机类型，默认为：db-2(基础型-SAS-V3)
VPCId (str) - VPC ID，不填为默认，VPC2.0下需要填写此字段。

Response

PHostId (list) - PHost的资源ID数组

describe_phost(req=None, **kwargs)[source]¶

DescribePHost - 获取物理机详细信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 返回数据长度，默认为20
Offset (int) - 数据偏移量，默认为0
PHostId (list) - PHost资源ID，若为空，则返回当前Region所有PHost。
Zone (str) - 可用区。参见可用区列表

Response

PHostSet (list) - 见 PHostSet 模型定义
TotalCount (int) - 满足条件的PHost总数

Response Model

PHostCPUSet

CoreCount (int) - CPU核数
Count (int) - CPU个数
Frequence (float) - CPU主频
Model (str) - CPU型号

PHostDiskSet

Count (int) - 磁盘数量
IOCap (int) - 磁盘IO性能，单位MB/s（待废弃）
Name (str) - 磁盘名称，sys/data
Space (int) - 单盘大小，单位GB
Type (str) - 磁盘属性

PHostIPSet

Bandwidth (int) - IP对应带宽，单位Mb，内网IP不显示带宽信息
IPAddr (str) - IP地址，
IPId (str) - IP资源ID(内网IP无资源ID)（待废弃）
MACAddr (str) - MAC地址
OperatorName (str) - 国际: Internation， BGP: BGP，内网: Private
SubnetId (str) - 子网ID
VPCId (str) - VPC ID

PHostSet

AutoRenew (str) - 自动续费
CPUSet (dict) - 见 PHostCPUSet 模型定义
ChargeType (str) - 计费模式，枚举值为： Year，按年付费； Month，按月付费； Dynamic，按需付费（需开启权限）； Trial，试用（需开启权限）默认为月付
Cluster (str) - 网络环境。枚举值：千兆：1G ，万兆：10G
Components (str) - 组件信息（暂不支持）
CreateTime (int) - 创建时间
DiskSet (list) - 见 PHostDiskSet 模型定义
ExpireTime (int) - 到期时间
IPSet (list) - 见 PHostIPSet 模型定义
ImageName (str) - 镜像名称
IsSupportKVM (str) - 是否支持紧急登录
Memory (int) - 内存大小，单位：MB
Name (str) - 物理机名称
OSType (str) - 操作系统类型
OSname (str) - 操作系统名称
PHostId (str) - PHost资源ID
PHostType (str) - 物理机类型，参见DescribePHostMachineType返回值
PMStatus (str) - 物理云主机状态。枚举值：> 初始化:Initializing; > 启动中：Starting； > 运行中：Running；> 关机中：Stopping； > 安装失败：InstallFailed； > 重启中：Rebooting；> 关机：Stopped；
PowerState (str) - 电源状态，on 或 off
RaidSupported (str) - 是否支持Raid。枚举值：Yes：支持；No：不支持。
Remark (str) - 物理机备注
SN (str) - 物理机序列号
Tag (str) - 业务组
Zone (str) - 可用区，参见可用区列表

describe_phost_image(req=None, **kwargs)[source]¶

DescribePHostImage - 获取物理云主机镜像列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - (Required) 可用区。参见可用区列表
ImageId (list) - 镜像ID
ImageType (str) - 镜像类别，枚举为：Base,标准镜像；默认为标准镜像。
Limit (int) - 返回数据长度，默认为20
Offset (int) - 数据偏移量，默认为0

Response

ImageSet (list) - 见 PHostImageSet 模型定义
TotalCount (int) - 满足条件的镜像总数

Response Model

PHostImageSet

ImageId (str) - 镜像ID
ImageName (str) - 镜像名称
OsName (str) - 操作系统名称
OsType (str) - 操作系统类型

describe_phost_tags(req=None, **kwargs)[source]¶

DescribePHostTags - 获取物理机tag列表（业务组）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - 可用区。参见可用区列表

Response

TagSet (list) - 见 PHostTagSet 模型定义
TotalCount (int) - Tag的个数

Response Model

PHostTagSet

Tag (str) - 业务组名称
TotalCount (int) - 该业务组中包含的主机个数

get_phost_price(req=None, **kwargs)[source]¶

GetPHostPrice - 获取物理机价格列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ChargeType (str) - (Required) 计费模式，枚举值为： Year/Month/Trial/Dynamic
Count (int) - (Required) 购买数量，范围[1-5]
Quantity (int) - (Required) 购买时长，1-10个月或1-10年
Cluster (str) - 网络环境，可选千兆：1G ，万兆：10G
Type (str) - 默认为：DB(数据库型)
Zone (str) - 可用区。参见可用区列表

Response

PriceSet (list) - 见 PHostPriceSet 模型定义

Response Model

PHostPriceSet

ChargeType (str) - Year/Month/Trial/Dynamic
Price (float) - 价格, 单位:元, 保留小数点后两位有效数字

modify_phost_info(req=None, **kwargs)[source]¶

ModifyPHostInfo - 更改物理机信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PHostId (str) - (Required) 物理机资源ID
Name (str) - 物理机名称，默认不更改
Remark (str) - 物理机备注，默认不更改
Tag (str) - 业务组，默认不更改
Zone (str) - 可用区。参见可用区列表

Response

PHostId (str) - PHost 的资源ID

poweroff_phost(req=None, **kwargs)[source]¶

PoweroffPHost - 断电物理云主机

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PHostId (str) - (Required) PHost资源ID
Zone (str) - 可用区。参见可用区列表

Response

PHostId (str) - PHost 的资源ID

reboot_phost(req=None, **kwargs)[source]¶

RebootPHost - 重启物理机

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PHostId (str) - (Required) PHost资源ID
Zone (str) - 可用区。参见可用区列表

Response

PHostId (str) - PHost 的资源ID

reinstall_phost(req=None, **kwargs)[source]¶

ReinstallPHost - 重装物理机操作系统

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PHostId (str) - (Required) PHost资源ID
Password (str) - (Required) 密码
Zone (str) - (Required) 可用区。参见可用区列表
ImageId (str) - 镜像Id，参考镜像列表，默认使用原镜像
Name (str) - 物理机名称，默认不更改
Raid (str) - 不保留数据盘重装，可选Raid
Remark (str) - 物理机备注，默认为不更改。
ReserveDisk (str) - 是否保留数据盘，保留：Yes，不报留：No，默认：Yes
Tag (str) - 业务组，默认不更改。

Response

PHostId (str) - PHost 的资源ID

start_phost(req=None, **kwargs)[source]¶

StartPHost - 启动物理机

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PHostId (str) - (Required) PHost资源ID
Zone (str) - 可用区。参见可用区列表

Response

PHostId (str) - PHost 的资源ID

terminate_phost(req=None, **kwargs)[source]¶

TerminatePHost - 删除物理云主机

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PHostId (str) - (Required) PHost资源ID
ReleaseEIP (bool) - 是否释放绑定的EIP。true: 解绑EIP后，并释放；其他值或不填：解绑EIP。
Zone (str) - 可用区。参见可用区列表

Response

PHostId (str) - PHost 的资源ID

USMS¶

class ucloud.services.usms.client.USMSClient(config, transport=None, middleware=None, logger=None)[source]¶

create_usms_signature(req=None, **kwargs)[source]¶

CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名

Request

ProjectId (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
CertificateType (int) - (Required) 签名的资质证明文件类型，需与签名类型保持一致，说明如下：0-三证合一/企业营业执照/组织机构代码证书/社会信用代码证书；1-应用商店后台开发者管理截图；2-备案服务商的备案成功截图(含域名，网站名称，备案号)；3-公众号或小程序的管理界面截图；4-商标注册证书；5-组织机构代码证书、社会信用代码证书；
Description (str) - (Required) 短信签名申请原因
File (str) - (Required) 短信签名的资质证明文件，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB
SigContent (str) - (Required) 短信签名名称；长度为2-12个字符, 可包含中文、数字和符号；无需填写【】或[]，系统会自动添加
SigPurpose (int) - (Required) 签名用途，0-自用，1-他用；
SigType (int) - (Required) 签名类型，说明如下：0-公司或企业的全称或简称；1-App应用的全称或简称；2-工信部备案网站的全称或简称；3-公众号或小程序的全称或简称；4-商标名的全称或简称；5-政府/机关事业单位/其他单位的全称或简称；
ProxyFile (str) - 短信签名授权委托文件，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB；当您是代理并使用第三方的签名时（也即SigPurpose为1-他用），该项为必填项；

Response

Message (str) - 返回状态码描述，如果操作成功，默认返回为空
SigContent (str) - 短信签名名称
SigId (str) - 短信签名ID（短信签名申请时的工单ID）

create_usms_template(req=None, **kwargs)[source]¶

CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板

Request

ProjectId (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Purpose (int) - (Required) 短信模板用途类型：1-验证码类短信模板；2-系统通知类短信模板；3-会员推广类短信模板；
Template (str) - (Required) 短信模板内容，说明如下：字数不超过500，每个中文、符号、英文、数组等都计为一个字；模板中的变量填写格式：{N}，其中N为大于1的整数，有多个参数时，建议N从1开始顺次，例如：{1}、{2}等；短信模板禁止仅包括变量的情况；
TemplateName (str) - (Required) 短信模板名称，不超过32个字符，每个中文、符号、英文、数字等都计为1个字。
Remark (str) - 短信模板申请原因说明，字数不超过128，每个中文、符号、英文、数字等都计为1个字。
UnsubscribeInfo (str) - 当Purpose为3时，也即会员推广类短信模板，该项必填。枚举值：TD退订、回T退订、回N退订、回TD退订、退订回T、退订回D、退订回TD、退订回复T、退订回复D、退订回复N、退订回复TD、拒收回T
Zone (str) - 可用区。参见可用区列表

Response

Message (str) - 返回状态码描述，如果操作成功，默认返回为空
TemplateId (str) - 短信模板ID（短信模板申请时的工单ID）

delete_usms_signature(req=None, **kwargs)[source]¶

DeleteUSMSSignature - 调用接口DeleteUSMSSignature删除短信签名

Request

ProjectId (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
SigIds (list) - (Required) 签名ID（也即短信签名申请时的工单ID），支持以数组的方式，举例，以SigIds.0、SigIds.1…SigIds.N方式传入

Response

Message (str) - 返回状态码描述，如果操作成功，默认返回为空

delete_usms_template(req=None, **kwargs)[source]¶

DeleteUSMSTemplate - 调用接口DeleteUSMSTemplate删除短信模板

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
TemplateIds (list) - (Required) 模板ID（也即短信模板申请时的工单ID），支持以数组的方式，举例，以TemplateIds.0、TemplateIds.1…TemplateIds.N方式传入
Zone (str) - 可用区。参见可用区列表

Response

Message (str) - 返回状态码描述，如果操作成功，默认返回为空

get_usms_send_receipt(req=None, **kwargs)[source]¶

GetUSMSSendReceipt - 获取短信发送回执信息。下游服务提供商回执信息返回会有一定延时，建议发送完短信以后，5-10分钟后再调用该接口拉取回执信息。若超过12小时未返回，则请联系技术支持确认原因

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SessionNoSet (list) - (Required) 发送短信时返回的SessionNo集合，SessionNoSet.0,SessionNoSet.1….格式
Zone (str) - 可用区。参见可用区列表

Response

Data (list) - 见 ReceiptPerSession 模型定义
Message (str) - 错误描述

Response Model

ReceiptPerPhone

CostCount (int) - 消耗短信条数
Phone (str) - 手机号码
ReceiptDesc (str) - 回执结果描述
ReceiptResult (str) - 回执结果
ReceiptTime (int) - 回执返回时间

ReceiptPerSession

ReceiptSet (list) - 见 ReceiptPerPhone 模型定义
SessionNo (str) - 发送短信时返回的SessionNo

query_usms_signature(req=None, **kwargs)[source]¶

QueryUSMSSignature - 调用接口QueryUSMSSignature查询短信签名申请状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
SigContent (str) - 签名内容；签名ID和签名至少需填写1项；
SigId (str) - 已申请的短信签名ID（短信签名申请时的工单ID）；签名ID和签名至少需填写1项；

Response

Data (dict) - 见 OutSignature 模型定义
Message (str) - 发生错误时，表示具体错误描述

Response Model

OutSignature

ErrDesc (str) - 签名审核失败原因
SigContent (str) - 签名内容
SigId (str) - 签名ID
Status (int) - 签名状态。0-待审核 1-审核中 2-审核通过 3-审核未通过 4-被禁用

query_usms_template(req=None, **kwargs)[source]¶

QueryUSMSTemplate - 调用接口QueryUSMSTemplate查询短信模板申请状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
TemplateId (str) - (Required) 模板ID

Response

Data (dict) - 见 OutTemplate 模型定义
Message (str) - 当RetCode不为0时，Message中显示具体错误描述

Response Model

OutTemplate

CreateTime (int) - 创建时间
ErrDesc (str) - 审核失败原因
Purpose (int) - 模板类型，选项：1-验证码类 2-通知类 3-会员推广类
Remark (str) - 模板说明
Status (int) - 短信模板状态；状态说明：0-待审核，1-审核中，2-审核通过，3-审核未通过，4-被禁用
Template (str) - 短信模板内容
TemplateId (str) - 短信模板ID
TemplateName (str) - 短信模板名称
UnsubscribeInfo (str) - 退订信息；一般填写方式“回T退订”，当purpose为3（也即会员推广类）时，为必填项

send_usms_message(req=None, **kwargs)[source]¶

SendUSMSMessage - 发送短信息。短信字数超过70个后，按照每66个进行切割(因为要加上1/3), 2/3)等字样，占用4个字长)。短信最大长度不能超过600个字。每个汉字、数字、字母、字符都按一个字计

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PhoneNumbers (list) - (Required) 电话号码数组，电话号码格式为(60)1xxxxxxxx，()中为国际长途区号(如中国为86或0086，两种格式都支持)，后面为电话号码.若不传入国际区号，如1851623xxxx，则默认为国内手机号
TemplateId (str) - (Required) 模板ID。若指定的模板ID审核未通过(status不等于2)则不允许发送
TemplateParams (list) - (Required) 模板参数数组，以TempalteParams.0，TempalteParams.1.。。格式。若模板ID指定的模板无可变参数，则不传入该参数。模板参数个数与模板不匹配，则不允许发送
SigContent (str) - 使用的签名，如果不输入则使用默认签名，若没有申请默认签名不允许发送；若输入的签名没有申请，则无法发送
Zone (str) - 可用区。参见可用区列表

Response

Action (str) - 操作名称
Message (str) - 发生错误时表示错误描述
RetCode (int) - 返回码
SessionNo (str) - 本次提交发送的短信的唯一ID，可根据该值查询本次发送的短信列表

update_usms_signature(req=None, **kwargs)[source]¶

UpdateUSMSSignature - 调用接口UpdateUSMSSignature修改未通过审核的短信签名，并重新提交审核

Request

ProjectId (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
File (str) - (Required) 短信签名的资质证明文件，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB
SigContent (str) - (Required) 新的短信签名名称；长度为2-12个字符, 可包含中文、数字和符号；无需填写【】或[]，系统会自动添加
SigId (str) - (Required) 签名ID（也即短信签名申请时的工单ID），支持以数组的方式，举例，以SigIds.0、SigIds.1…SigIds.N方式传入
SigPurpose (int) - (Required) 签名用途，0-自用，1-他用；
SigType (int) - (Required) 签名类型，说明如下：0-公司或企业的全称或简称；1-App应用的全称或简称；2-工信部备案网站的全称或简称；3-公众号或小程序的全称或简称；4-商标名的全称或简称；5-政府/机关事业单位/其他单位的全称或简称；
CertificateType (int) - 签名的资质证明文件类型，需与签名类型保持一致，说明如下：0-三证合一/企业营业执照/组织机构代码证书/社会信用代码证书；1-应用商店后台开发者管理截图；2-备案服务商的备案成功截图(含域名，网站名称，备案号)；3-公众号或小程序的管理界面截图；4-商标注册证书；5-组织机构代码证书、社会信用代码证书；
ProxyFile (str) - 短信签名授权委托文件，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB；当您是代理并使用第三方的签名时（也即SigPurpose为1-他用），该项为必填项；

Response

Message (str) - 返回状态码描述，如果操作成功，默认返回为空

update_usms_template(req=None, **kwargs)[source]¶

UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板，并重新提交审核

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Template (str) - (Required) 新的模板内容。模板名称和模板内容必须提供一个，否则会报错。小于等于600个字
TemplateId (str) - (Required) 短信模板ID
Remark (str) - 短信模板申请原因说明，字数不超过128，每个中文、符号、英文、数字等都计为1个字。
TemplateName (str) - 新的模板名称。小于等于32个字，每个中文、英文、数组、符合都计为一个字
UnsubscribeInfo (str) - 当Purpose为3时，也即会员推广类短信模板，该项必填。枚举值：TD退订、回T退订、回N退订、回TD退订、退订回T、退订回D、退订回TD、退订回复T、退订回复D、退订回复N、退订回复TD、拒收回T
Zone (str) - 可用区。参见可用区列表

Response

Message (str) - 发生错误时表示错误描述

VPC¶

class ucloud.services.vpc.client.VPCClient(config, transport=None, middleware=None, logger=None)[source]¶

add_vpc_network(req=None, **kwargs)[source]¶

AddVPCNetwork - 添加VPC网段

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Network (list) - (Required) 增加网段
VPCId (str) - (Required) 源VPC短ID

Response

associate_route_table(req=None, **kwargs)[source]¶

AssociateRouteTable - 绑定子网的路由表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RouteTableId (str) - (Required) 路由表ID，仅限自定义路由表
SubnetId (str) - (Required) 子网ID

Response

clone_route_table(req=None, **kwargs)[source]¶

CloneRouteTable - 根据一张现有路由表复制一张新的路由表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RouteTableId (str) - (Required) 被克隆的路由表ID

Response

create_route_table(req=None, **kwargs)[source]¶

CreateRouteTable - 创建路由表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
VPCId (str) - (Required) VPC ID
Name (str) - 路由表名称 Default RouteTable
Remark (str) - 备注
Tag (str) - 业务组

Response

RouteTableId (str) - 路由表ID

create_subnet(req=None, **kwargs)[source]¶

CreateSubnet - 创建子网

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Subnet (str) - (Required) 子网网络地址，例如192.168.0.0
VPCId (str) - (Required) VPC资源ID
Netmask (int) - 子网网络号位数，默认为24
Remark (str) - 备注
SubnetName (str) - 子网名称，默认为Subnet
Tag (str) - 业务组名称，默认为Default

Response

SubnetId (str) - 子网ID

create_vpc(req=None, **kwargs)[source]¶

CreateVPC - 创建VPC

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) VPC名称
Network (list) - (Required) VPC网段
Remark (str) - 备注
Tag (str) - 业务组名称
Type (int) - VPC类型

Response

VPCId (str) - VPC资源Id

create_vpc_intercom(req=None, **kwargs)[source]¶

CreateVPCIntercom - 新建VPC互通关系

Request

ProjectId (str) - (Config) 源VPC所在项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 源VPC所在地域。参见地域和可用区列表
DstVPCId (str) - (Required) 目的VPC短ID
VPCId (str) - (Required) 源VPC短ID
DstProjectId (str) - 目的VPC项目ID。默认与源VPC同项目。
DstRegion (str) - 目的VPC所在地域，默认与源VPC同地域。

Response

delete_route_table(req=None, **kwargs)[source]¶

DeleteRouteTable - 删除自定义路由表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RouteTableId (str) - (Required) 路由ID

Response

delete_subnet(req=None, **kwargs)[source]¶

DeleteSubnet - 删除子网

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SubnetId (str) - (Required) 子网ID

Response

delete_vpc(req=None, **kwargs)[source]¶

DeleteVPC - 删除VPC

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
VPCId (str) - (Required) VPC资源Id

Response

delete_vpc_intercom(req=None, **kwargs)[source]¶

DeleteVPCIntercom - 删除VPC互通关系

Request

ProjectId (str) - (Config) 源VPC所在项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 源VPC所在地域。参见地域和可用区列表
DstVPCId (str) - (Required) 目的VPC短ID
VPCId (str) - (Required) 源VPC短ID
DstProjectId (str) - 目的VPC所在项目ID，默认为源VPC所在项目ID
DstRegion (str) - 目的VPC所在地域，默认为源VPC所在地域

Response

describe_route_table(req=None, **kwargs)[source]¶

DescribeRouteTable - 获取路由表详细信息(包括路由策略)

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BusinessId (str) - 业务组ID
Limit (int) - Limit
OffSet (int) - OffSet
RouteTableId (str) - 路由表ID
VPCId (str) - VPC ID

Response

RouteTables (list) - 见 RouteTableInfo 模型定义
TotalCount (int) - RouteTables字段的数量

Response Model

RouteRuleInfo

DstAddr (str) - 目的地址，比如10.10.8/24
NexthopId (str) - 路由下一跳ID，比如uvnet-3eljvj
NexthopType (str) - 下一跳类型，比如local、vnet
Remark (str) - 路由规则备注
RouteRuleId (str) - 规则ID
RuleType (int) - 路由规则类型（0表示系统路由，1表示自定义路由）

RouteTableInfo

CreateTime (int) - 创建时间戳
Remark (str) - 路由表备注
RouteRules (list) - 见 RouteRuleInfo 模型定义
RouteTableId (str) - 路由表ID
RouteTableType (int) - 路由表类型，1为默认，0为自定义
SubnetCount (str) - 绑定了该路由表的子网数量
Tag (str) - 业务组
VPCId (str) - 路由表所属vpc
VPCName (str) - vpc名称

describe_subnet(req=None, **kwargs)[source]¶

DescribeSubnet - 获取子网信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BusinessId (str) - 业务组
Limit (int) - 列表长度，默认为20
Offset (int) - 偏移量，默认为0
RouteTableId (str) - 路由表Id
ShowAvailableIPs (bool) - 是否返回子网的可用IP数，true为是，false为否，默认不返回
SubnetId (str) - 子网id，适用于一次查询一个子网信息
SubnetIds (list) - 子网id数组，适用于一次查询多个子网信息
Tag (str) - 业务组名称，默认为Default
VPCId (str) - VPC资源id

Response

DataSet (list) - 见 SubnetInfo 模型定义
TotalCount (int) - 子网总数量

Response Model

SubnetInfo

AvailableIPs (int) - 可用IP数量
CreateTime (int) - 创建时间
Gateway (str) - 子网网关
HasNATGW (bool) - 是否有natgw
IPv6Network (str) - 子网关联的IPv6网段
Netmask (str) - 子网掩码
Remark (str) - 备注
RouteTableId (str) - 路由表Id
Subnet (str) - 子网网段
SubnetId (str) - 子网Id
SubnetName (str) - 子网名称
SubnetType (int) - 子网类型
Tag (str) - 业务组
VPCId (str) - VPCId
VPCName (str) - VPC名称
Zone (str) - 可用区名称

describe_subnet_resource(req=None, **kwargs)[source]¶

DescribeSubnetResource - 展示子网资源 Request - ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口 - Region (str) - (Config) 地域。参见地域和可用区列表 - SubnetId (str) - (Required) 子网id - Limit (int) - 单页返回数据长度，默认为20 - Offset (int) - 列表起始位置偏移量，默认为0 - ResourceType (str) - 资源类型，默认为全部资源类型。枚举值为：UHOST，云主机；PHOST，物理云主机；ULB，负载均衡；UHADOOP_HOST，hadoop节点；UFORTRESS_HOST，堡垒机；UNATGW，NAT网关；UKAFKA，Kafka消息队列；UMEM，内存存储；DOCKER，容器集群；UDB，数据库；UDW，数据仓库；VIP，内网VIP.

Response - DataSet (list) - 见 SubnetResource 模型定义 - TotalCount (int) - 总数

Response Model

SubnetResource

IP (str) - 资源ip
IPv6Address (str) - 资源的IPv6地址
Name (str) - 资源名称
ResourceId (str) - 资源Id
ResourceType (str) - 资源类型。对应的资源类型：UHOST，云主机；PHOST，物理云主机；ULB，负载均衡；UHADOOP_HOST，hadoop节点；UFORTRESS_HOST，堡垒机；UNATGW，NAT网关；UKAFKA，Kafka消息队列；UMEM，内存存储；DOCKER，容器集群；UDB，数据库；UDW，数据仓库；VIP，内网VIP.
SubResourceId (str) - 资源绑定的虚拟网卡的实例ID
SubResourceName (str) - 资源绑定的虚拟网卡的实例名称
SubResourceType (str) - 资源绑定的虚拟网卡的类型

describe_vpc(req=None, **kwargs)[source]¶

DescribeVPC - 获取VPC信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) -
Offset (int) -
Tag (str) - 业务组名称
VPCIds (list) - VPCId

Response

DataSet (list) - 见 VPCInfo 模型定义

Response Model

VPCNetworkInfo

Network (str) - vpc地址空间
SubnetCount (int) - 地址空间中子网数量

VPCInfo

CreateTime (int) -
IPv6Network (str) - VPC关联的IPv6网段
Name (str) -
Network (list) -
NetworkInfo (list) - 见 VPCNetworkInfo 模型定义
OperatorName (str) - VPC关联的IPv6网段所属运营商
SubnetCount (int) -
Tag (str) -
UpdateTime (int) -
VPCId (str) - VPCId

describe_vpc_intercom(req=None, **kwargs)[source]¶

DescribeVPCIntercom - 获取VPC互通信息

Request

ProjectId (str) - (Config) 源VPC所在项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 源VPC所在地域。参见地域和可用区列表
VPCId (str) - (Required) VPC短ID
DstProjectId (str) - 目的项目ID，默认为全部项目
DstRegion (str) - 目的VPC所在地域，默认为全部地域

Response

DataSet (list) - 见 VPCIntercomInfo 模型定义

Response Model

VPCIntercomInfo

DstRegion (str) - 所属地域
Name (str) - VPC名字
Network (list) - VPC的地址空间
ProjectId (str) - 项目Id
Tag (str) - 业务组（未分组显示为 Default）
VPCId (str) - VPCId

modify_route_rule(req=None, **kwargs)[source]¶

ModifyRouteRule - 路由策略增、删、改

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RouteRule (list) - (Required) 格式: RouteRuleId | 目的网段 | 下一跳类型 | 下一跳 |优先级| 备注 | 增、删、改标志 (下一跳类型为instance或者vip，下一跳为云主机id或者vip的id，优先级使用0，动作标志为add/delete/update) 。”添加”示例: test_id | 10.8.0.0/16 | instance | uhost-xd8ja | 0 | Default Route Rule| add (添加的RouteRuleId填任意非空字符串) 。”删除”示例: routerule-xk3jxa | 10.8.0.0/16 | instance | uhost-xd8ja | 0 | Default Route Rule| delete (RouteRuleId来自DescribeRouteTable中) 。“修改”示例: routerule-xk3jxa | 10.8.0.0/16 | instance | uhost-cjksa2 | 0 | Default Route Rule| update (RouteRuleId来自DescribeRouteTable中)
RouteTableId (str) - (Required) 通过DescribeRouteTable拿到

Response

update_route_table_attribute(req=None, **kwargs)[source]¶

UpdateRouteTableAttribute - 更新路由表基本信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RouteTableId (str) - (Required) 路由表ID
Name (str) - 名称
Remark (str) - 备注
Tag (str) - 业务组名称

Response

update_subnet_attribute(req=None, **kwargs)[source]¶

UpdateSubnetAttribute - 更新子网信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SubnetId (str) - (Required) 子网ID
Name (str) - 子网名称(如果Name不填写，Tag必须填写)
Tag (str) - 业务组名称(如果Tag不填写，Name必须填写)

Response

update_vpc_network(req=None, **kwargs)[source]¶

UpdateVPCNetwork - 更新VPC网段

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Network (list) - (Required) 需要保留的VPC网段。当前仅支持删除VPC网段，添加网段请参考 AddVPCNetwork
VPCId (str) - (Required) VPC的ID

Response

Message (str) - 错误信息

IPSecVPN¶

class ucloud.services.ipsecvpn.client.IPSecVPNClient(config, transport=None, middleware=None, logger=None)[source]¶

describe_remote_vpn_gateway(req=None, **kwargs)[source]¶

DescribeRemoteVPNGateway - 获取客户VPN网关信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 数据分页值, 默认为20
Offset (int) - 数据偏移量, 默认为0
RemoteVPNGatewayIds (list) - 客户VPN网关的资源ID，例如RemoteVPNGatewayIds.0代表希望获取客户VPN网关1的信息，RemoteVPNGatewayIds.1代表客户VPN网关2，如果为空，则返回当前Region中所有客户VPN网关实例的信息
Tag (str) - 业务组名称，若指定则返回业务组下所有客户VPN网关信息

Response

DataSet (list) - 见 RemoteVPNGatewayDataSet 模型定义
TotalCount (int) - 符合条件的客户VPN网关总数

Response Model

RemoteVPNGatewayDataSet

ActiveTunnels (str) - 活跃的隧道id
CreateTime (int) - 创建时间
Remark (str) - 备注
RemoteVPNGatewayAddr (str) - 客户网关IP地址
RemoteVPNGatewayId (str) - 客户网关ID
RemoteVPNGatewayName (str) - 客户网关名称
Tag (str) - 用户组
TunnelCount (int) - 活跃的隧道数量

describe_vpn_tunnel(req=None, **kwargs)[source]¶

DescribeVPNTunnel - 获取VPN隧道信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 数据分页值, 默认为20
Offset (int) - 数据偏移量, 默认为0
Tag (str) - 业务组名称，若指定则返回指定的业务组下的所有VPN网关的信息
VPNTunnelIds (list) - VPN隧道的资源ID，例如VPNTunnelIds.0代表希望获取信息的VPN隧道1，VPNTunneIds.1代表VPN隧道2，如果为空，则返回当前Region中所有的VPN隧道实例

Response

DataSet (list) - 见 VPNTunnelDataSet 模型定义
TotalCount (int) - VPN隧道总数

Response Model

IPSecData

IPSecAuthenticationAlgorithm (str) - IPSec通道中使用的认证算法
IPSecEncryptionAlgorithm (str) - IPSec通道中使用的加密算法
IPSecLocalSubnetIds (list) - 指定VPN连接的本地子网，用逗号分隔
IPSecPFSDhGroup (str) - 是否开启PFS功能,Disable表示关闭，数字表示DH组
IPSecProtocol (str) - 使用的安全协议，ESP或AH
IPSecRemoteSubnets (list) - 指定VPN连接的客户网段，用逗号分隔
IPSecSALifetime (str) - IPSec中SA的生存时间
IPSecSALifetimeBytes (str) - IPSec中SA的生存时间（以字节计）

IKEData

IKEAuthenticationAlgorithm (str) - IKE认证算法
IKEDhGroup (str) - IKEDH组
IKEEncryptionAlgorithm (str) - IKE加密算法
IKEExchangeMode (str) - IKEv1协商模式
IKELocalId (str) - IKE本地ID标识
IKEPreSharedKey (str) - IKE预共享秘钥
IKERemoteId (str) - IKE对端ID标识
IKESALifetime (str) - IKE秘钥生存时间
IKEVersion (str) - IKE版本

VPNTunnelDataSet

CreateTime (int) - 创建时间
IKEData (dict) - 见 IKEData 模型定义
IPSecData (dict) - 见 IPSecData 模型定义
Remark (str) - 备注
RemoteVPNGatewayId (str) - 对端网关Id
RemoteVPNGatewayName (str) - 对端网关名字
Tag (str) - 用户组
VPCId (str) - 所属VPCId
VPCName (str) - 所属VOC名字
VPNGatewayId (str) - 所属VPN网关id
VPNGatewayName (str) - VPN网关名字
VPNTunnelId (str) - 隧道id
VPNTunnelName (str) - 隧道名称

UCloudStack¶

class ucloud.services.ucloudstack.client.UCloudStackClient(config, transport=None, middleware=None, logger=None)[source]¶

allocate_eip(req=None, **kwargs)[source]¶

AllocateEIP - 申请外网IP

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
Bandwidth (int) - (Required) 带宽，默认值1，默认范围1~100
ChargeType (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
Name (str) - (Required) 名称
OperatorName (str) - (Required) 线路。目前支持Bgp
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Quantity (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。

Response

EIPID (str) - 申请的EIP的ID
Message (str) - 返回信息描述。

attach_disk(req=None, **kwargs)[source]¶

AttachDisk - 绑定硬盘

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
DiskID (str) - (Required) 硬盘ID
ResourceID (str) - (Required) 绑定的资源ID
ResourceType (str) - (Required) 绑定的资源类型，枚举值：VM，标识虚拟机
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

bind_alarm_template(req=None, **kwargs)[source]¶

BindAlarmTemplate - 绑定告警模板

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
AlarmTemplateID (str) - (Required) 告警模板ID
ResourceIDs (list) - (Required) 【数组】告警模板ID。调用方式举例：ResourceIDs.0=“one-id”、ResourceIDs.1=“two-id”。
ResourceType (str) - (Required) 资源类型。VM：虚拟机, LB:负载均衡, NATGW：nat网关;EIP:弹性IP
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述

bind_eip(req=None, **kwargs)[source]¶

BindEIP - 绑定UCoudStack外网IP

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；中国
EIPID (str) - (Required) 外网IP的ID
ResourceID (str) - (Required) 资源ID
ResourceType (str) - (Required) 资源类型。VM：虚拟机, LB:负载均衡, NATGW：nat网关
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回描述

bind_physical_ip(req=None, **kwargs)[source]¶

BindPhysicalIP - 绑定物理 IP ，被绑定的资源必须处于运行中或有效状态。

Request

Region (str) - (Config) 地域。
PhysicalIPID (str) - (Required) 物理IP的ID
ResourceID (str) - (Required) 资源ID
ResourceType (str) - (Required) 资源类型。VM：虚拟机
Zone (str) - (Required) 可用区。

Response

Message (str) - 返回描述

bind_security_group(req=None, **kwargs)[source]¶

BindSecurityGroup - 绑定安全组

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
ResourceID (str) - (Required) 绑定的资源ID。调用方式举例：ResourceID=“one-id”。
SGID (str) - (Required) 安全组ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
NICID (str) - 网卡ID

Response

Message (str) - 返回信息描述

clone_disk(req=None, **kwargs)[source]¶

CloneDisk - 克隆硬盘

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
ChargeType (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
Name (str) - (Required) 名称
SrcID (str) - (Required) 源硬盘ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Quantity (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。

Response

DiskID (str) - 克隆出的硬盘ID
Message (str) - 返回信息描述。

create_certificate(req=None, **kwargs)[source]¶

CreateCertificate - 创建证书

Request

Region (str) - (Config) 地域。参见地域和可用区列表
Certificate (str) - (Required) 证书内容
CertificateType (str) - (Required) 证书类型，枚举值[“ServerCrt”,”CACrt”]。分别表示服务器证书和CA证书。只有在双向认证的时候才需要CA证书
Name (str) - (Required) 证书名称
Zone (str) - (Required) 可用区。参见可用区列表
PrivateKey (str) - 私钥内容,服务器证书必传,CA证书不用传递
Remark (str) - 证书描述

Response

CertificateID (str) - 证书ID
Message (str) - 错误描述

create_custom_image(req=None, **kwargs)[source]¶

CreateCustomImage - 创建自制镜像

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
ImageName (str) - (Required) 镜像名称
VMID (str) - (Required) 虚拟机ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
ImageDescription (str) - 镜像描述。

Response

ImageID (str) - 创建的自制镜像ID
Message (str) - 返回信息描述。

create_disk(req=None, **kwargs)[source]¶

CreateDisk - 创建硬盘

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
ChargeType (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
DiskSpace (int) - (Required) 磁盘大小
Name (str) - (Required) 磁盘名称
SetType (str) - (Required) 磁盘类型。例如：Normal,SSD
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Quantity (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。

Response

DiskID (str) - 创建的磁盘ID
Message (str) - 返回信息描述。

create_lb(req=None, **kwargs)[source]¶

CreateLB - 创建负载均衡

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
ChargeType (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
LBType (str) - (Required) 枚举值。LAN：内网，WAN:外网
Name (str) - (Required) 名称。
SubnetID (str) - (Required) LB 实例所在的子网 ID 。
VMType (str) - (Required) 运行负载均衡实例的主机机型。枚举值：如 Normal ，表示普通机型； SSD，表示 SSD 机型。（机型由平台管理员修改和指定，可参考获取主机机型接口）
VPCID (str) - (Required) LB实例所在的 VPC ID 。
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
EIPID (str) - 外网IP的ID，创建外网LB时为必需
Quantity (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。
Remark (str) - 描述。
SGID (str) - 安全组ID，创建外网LB时为必需

Response

LBID (str) - 返回创建的负载均衡ID
Message (str) - 返回信息描述。

create_natgw(req=None, **kwargs)[source]¶

CreateNATGW - 创建NAT网关

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
ChargeType (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
EIPID (str) - (Required) 外网IP的ID
Name (str) - (Required) 名称。
SGID (str) - (Required) 安全组ID
SubnetID (str) - (Required) NAT网关实例所在的子网 ID
VMType (str) - (Required) 运行NAT网关实例的主机机型。枚举值：如 Normal ，表示普通机型； SSD，表示 SSD 机型。（机型由平台管理员修改和指定，可参考获取主机机型接口）
VPCID (str) - (Required) NAT网关实例所在的 VPC ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Quantity (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。
Remark (str) - 描述

Response

Message (str) - 返回信息描述。
NATGWID (str) - 返回创建的NAT网关ID

create_natgw_rule(req=None, **kwargs)[source]¶

CreateNATGWRule - 添加NAT网关白名单

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
BindResourceID (str) - (Required) 绑定的虚拟机资源ID
NATGWID (str) - (Required) NAT网关ID
NATGWType (str) - (Required) NAT的类型。枚举值：SNAT，DNAT
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。
RuleID (str) - 白名单ID

create_physical_ip(req=None, **kwargs)[source]¶

CreatePhysicalIP - 创建物理 IP ，需确保平台已配置物理 IP 线路相关信息及物理网络联通性。

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
Name (str) - (Required) 物理IP名称，限制字符长度30
OperatorName (str) - (Required) 物理IP线路
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Remark (str) - 描述

Response

Message (str) - 返回信息描述
PhysicalIPID (str) - 返回创建的物理IP的ID

create_rs(req=None, **kwargs)[source]¶

CreateRS - 为负载均衡的 VServer 添加后端服务节点。

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
BindResourceID (str) - (Required) 服务节点的资源 ID ，仅支持添加与 LB 相同 VPC 的虚拟机资源
LBID (str) - (Required) 负载均衡ID
Port (int) - (Required) 服务节点暴露的服务端口号
VSID (str) - (Required) VServer的ID
Weight (int) - (Required) 服务节点的权重
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。
RSID (str) - 返回创建的RSID

create_security_group(req=None, **kwargs)[source]¶

CreateSecurityGroup - 创建安全组

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Name (str) - (Required) 名称;
Rule (list) - (Required) 【数组】安全组规则。输入有效的规则，调用方式举例：Rule.0=“TCP|23|0.0.0.0/0|ACCEPT|HIGH|1”、Rule.1=“TCP|55|0.0.0.0/0|ACCEPT|HIGH|1”
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Remark (str) - 描述;

Response

Message (str) - 返回信息描述；
SGID (str) - 创建的安全组ID

create_security_group_rule(req=None, **kwargs)[source]¶

CreateSecurityGroupRule - 创建安全组规则

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Rules (list) - (Required) 【数组】安全组规则。输入有效的规则，调用方式举例：Rule.0=“TCP|23|0.0.0.0/0|ACCEPT|HIGH|1”、Rule.1=“TCP|55|0.0.0.0/0|ACCEPT|HIGH|1”
SGID (str) - (Required) 安全组ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述；
SGRuleID (str) - 创建的安全组规则ID

create_snapshot(req=None, **kwargs)[source]¶

CreateSnapshot - 创建硬盘快照

Request

Region (str) - (Config) 地域。枚举值：如 cn,表示中国。
DiskID (str) - (Required) 硬盘ID，输入“有效”状态的ID
Name (str) - (Required) 快照名称，限制字符长度30
Zone (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。
Remark (str) - 描述，限制字符长度100

Response

Message (str) - 返回信息描述
SnapshotID (str) - 创建的快照ID

create_subnet(req=None, **kwargs)[source]¶

CreateSubnet - 创建子网

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Name (str) - (Required) 名称;
Network (str) - (Required) 网段。列如：10.0.0.0/16；
VPCID (str) - (Required) 所属VPCID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Remark (str) - 描述;

Response

Message (str) - 返回信息描述；
SubnetID (str) - 创建Subnet的ID；

create_user(req=None, **kwargs)[source]¶

CreateUser - 管理员添加账号

Request

PassWord (str) - (Required) 账号密码。
UserEmail (str) - (Required) 账号邮箱。

Response

Message (str) - 返回信息描述。
UserID (int) - 账户ID

create_vm_instance(req=None, **kwargs)[source]¶

CreateVMInstance - 创建虚拟机

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
BootDiskSetType (str) - (Required) 系统盘类型。枚举值：Normal，表示普通；SSD，表示SSD；
CPU (int) - (Required) CPU个数，如1，2，4，8，16，32，64等。
ChargeType (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
DataDiskSetType (str) - (Required) 数据盘类型。枚举值：Normal，表示普通；SSD，表示SSD；
ImageID (str) - (Required) 镜像 ID。基础镜像 ID 或者自制镜像 ID。如：cn-image-centos-74。
Memory (int) - (Required) 内存容量，如1024，2048，4096，8192，16384，32768，65535等。
Name (str) - (Required) 虚拟机名称。可输入如：myVM。名称只能包含中英文、数字以及- _ .且1-30个字符。
Password (str) - (Required) 密码。可输入如：ucloud.cn。密码长度限6-30个字符；需要同时包含两项或以上（大写字母/小写字母/数字/特殊符号)；windows不能包含用户名（administrator）中超过2个连续字符的部分。
SubnetID (str) - (Required) 子网 ID。
VMType (str) - (Required) 机型。枚举值：Normal，表示普通；SSD，表示SSD；
VPCID (str) - (Required) VPC ID。
WANSGID (str) - (Required) 外网安全组 ID。输入“有效”状态的安全组的ID。
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Bandwidth (str) - 带宽
DataDiskSpace (int) - 数据盘大小，单位 GB。默认值为0。范围：【0，8000】，步长10。
GPU (int) - GPU 卡核心的占用个数。枚举值：【1,2,4】。GPU与CPU、内存大小关系：CPU个数>=4*GPU个数，同时内存与CPU规格匹配.
IPVersion (str) - 外网IP版本，默认IPv4
InternalIP (str) - 指定内网IP。输入有效的指定内网 IP。默认为系统自动分配内网 IP。
InternetIP (str) - 指定外网IP
LANSGID (str) - 内网安全组 ID。输入“有效”状态的安全组的ID。
OperatorName (str) - 线路
Quantity (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。

Response

DiskID (str) - 返回创建数据盘的 ID
EIPID (str) - 返回创建外网IP的 ID
Message (str) - 返回信息描述。
VMID (str) - 返回创建虚拟机的 ID

create_vpc(req=None, **kwargs)[source]¶

CreateVPC - 创建VPC

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Name (str) - (Required) 名称;
Network (str) - (Required) 网段。例如：10.0.0.0/16；
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Remark (str) - 描述;

Response

Message (str) - 返回信息描述；
VPCID (str) - 创建的VPCID；

create_vs(req=None, **kwargs)[source]¶

CreateVS - 创建负载均衡VServer

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
HealthcheckType (str) - (Required) 健康检查类型，枚举值，Port:端口,Path:域名。TCP和UDP协议只支持Port类型。
LBID (str) - (Required) 负载均衡ID
Port (int) - (Required) VServer 的监听端口。端口范围为 1~65535 ，其中 323、9102、9103、9104、9105、60909、60910 被系统占用。
Protocol (str) - (Required) VServer 的监听协议。枚举值：支持 TCP、UDP、HTTP、HTTPS 四种协议转发。
Scheduler (str) - (Required) 负载均衡的调度算法。枚举值：wrr:加权轮训；least_conn:最小连接数；hash:原地址,四层lb使用。ip_hash:七层lb使用
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
CACertificateID (str) - CA证书ID，用于验证客户端证书的签名，仅当VServer监听协议为 HTTPS 且 SSLMode 为双向认证时有效。
Domain (str) - HTTP 健康检查时校验请求的 HOST 字段中的域名。当健康检查类型为端口检查时，该值为空。
KeepaliveTimeout (int) - 负载均衡的连接空闲超时时间，单位为秒，默认值为 60s 。
Path (str) - HTTP 健康检查的路径，健康检查类型为 HTTP 检查时为必填项。当健康检查类型为端口检查时，该值为空。
PersistenceKey (str) - 会话保持KEY，会话保持类型为Manual时为必填项，仅当 VServer 协议为 HTTP 时有效。
PersistenceType (str) - 会话保持类型。枚举值：None:关闭；Auto:自动生成；Manual:手动生成。当协议为 TCP 时，该值不生效，会话保持和选择的调度算法相关；当协议为 UDP 时 Auto 表示开启会话保持。
SSLMode (str) - SSL认证模式,HTTPS协议下必传,取值范围[“simplex”,”duplex”]分别表示单向认证和双向认证。
ServerCertificateID (str) - 服务器证书ID，用于证明服务器的身份，仅当 VServer监听协议为 HTTPS时有效。

Response

Message (str) - 返回信息描述。
VSID (str) - 返回创建的VSID

create_vs_policy(req=None, **kwargs)[source]¶

CreateVSPolicy - 创建七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) 负载均衡ID
RSIDs (list) - (Required) 【数组】内容转发规则应用的服务节点的 ID，来源于 VServer 中添加的服务节点。调用方式举例：RSIDs.0=“one-id”、RSIDs.1=“two-id”。
VSID (str) - (Required) VServer的ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Domain (str) - 内容转发规则关联的请求域名，值可为空，即代表仅匹配路径。域名和路径至少需要指定一项，且域名和路径的组合在一个 VServer 中必须唯一。
Path (str) - 内容转发规则关联的请求访问路径，如 “/” 。域名和路径至少需要指定一项，且域名和路径的组合在一个 VServer 中必须唯一。

Response

Message (str) - 返回信息描述。
PolicyID (str) - 返回创建的内容转发规则ID

delete_certificate(req=None, **kwargs)[source]¶

DeleteCertificate - 删除证书

Request

Region (str) - (Config) 地域。参见地域和可用区列表
CertificateID (str) - (Required) 证书ID
Zone (str) - (Required) 可用区。参见可用区列表

Response

Message (str) - 返回信息描述

delete_custom_image(req=None, **kwargs)[source]¶

DeleteCustomImage - 删除自制镜像

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
ImageID (str) - (Required) 自制镜像ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

delete_disk(req=None, **kwargs)[source]¶

DeleteDisk - 删除硬盘

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
DiskID (str) - (Required) 被删除的硬盘ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

delete_lb(req=None, **kwargs)[source]¶

DeleteLB - 删除负载均衡

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) 负载均衡ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

delete_natgw(req=None, **kwargs)[source]¶

DeleteNATGW - 删除NAT网关

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
NATGWID (str) - (Required) NAT网关ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

delete_natgw_rule(req=None, **kwargs)[source]¶

DeleteNATGWRule - 删除NAT网关白名单

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
NATGWID (str) - (Required) nat网关ID
RuleID (str) - (Required) 白名单ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

delete_physical_ip(req=None, **kwargs)[source]¶

DeletePhysicalIP - 删除物理IP

Request

Region (str) - (Config) 地域。
PhysicalIPID (str) - (Required) 物理IP的ID
Zone (str) - (Required) 可用区。

Response

Message (str) - 返回状态描述

delete_rs(req=None, **kwargs)[source]¶

DeleteRS - 移除负载均衡的单个服务节点

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) 负载均衡ID
RSID (str) - (Required) RServer的ID
VSID (str) - (Required) VServer的ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

delete_security_group(req=None, **kwargs)[source]¶

DeleteSecurityGroup - 删除安全组

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
SGID (str) - (Required) 安全组ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述；

delete_security_group_rule(req=None, **kwargs)[source]¶

DeleteSecurityGroupRule - 删除安全组规则

Request

Region (str) - (Config) 地域。
SGID (str) - (Required) 安全组ID
SGRuleID (str) - (Required) 安全组规则ID
Zone (str) - (Required) 可用区。

Response

Message (str) - 返回信息描述；

delete_snapshot(req=None, **kwargs)[source]¶

DeleteSnapshot - 删除快照，仅支持状态为正常的快照进行删除操作。

Request

Region (str) - (Config) 地域。枚举值：如 cn,表示中国。
SnapshotID (str) - (Required) 快照ID
Zone (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。

Response

Message (str) - 返回信息描述

delete_subnet(req=None, **kwargs)[source]¶

DeleteSubnet - 删除子网

Request

Region (str) - (Config) 地域。
SubnetID (str) - (Required) SubnetID
Zone (str) - (Required) 可用区。

Response

Message (str) - 返回信息描述；

delete_vm_instance(req=None, **kwargs)[source]¶

DeleteVMInstance - 删除虚拟机

Request

Region (str) - (Config) 地域。枚举值：cn，表示中国；
VMID (str) - (Required) 虚拟机 ID。输入有效的虚拟机 ID。
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

delete_vpc(req=None, **kwargs)[source]¶

DeleteVPC - 删除VPC

Request

Region (str) - (Config) 地域。
VPCID (str) - (Required) ID
Zone (str) - (Required) 可用区。

Response

Message (str) - 返回信息描述；

delete_vs(req=None, **kwargs)[source]¶

DeleteVS - 删除VServer

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) VServer 监听器所属的负载均衡 ID
VSID (str) - (Required) 负载均衡VServer监听器ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

delete_vs_policy(req=None, **kwargs)[source]¶

DeleteVSPolicy - 删除七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) 负载均衡ID
PolicyID (str) - (Required) 内容转发规则ID
VSID (str) - (Required) VServer的ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

describe_certificate(req=None, **kwargs)[source]¶

DescribeCertificate - 查询证书

Request

Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - (Required) 可用区。参见可用区列表
CertificateIDs (list) - 证书ID列表
CertificateType (str) - 证书类型，枚举值[“ServerCrt”,”CACrt”]。分别表示服务器证书和CA证书。
Limit (int) - 返回数据长度，默认为20，最大100
Offset (int) - 列表起始位置偏移量，默认为0

Response

Infos (list) - 见 CertificateInfo 模型定义
Message (str) - 返回信息描述
TotalCount (int) - 证书总个数

Response Model

BindVSInfo

LBID (str) - LB ID
LBName (str) - LB名称
Port (int) - VS的端口
Protocol (str) - VS的协议
VSID (str) - VS ID

CertificateInfo

CertificateContent (str) - 证书内容
CertificateID (str) - 证书ID
CertificateType (str) - 证书类型，枚举值[“ServerCrt”,”CACrt”]
CommonName (str) - 主域名
CreateTime (int) - 创建时间（平台创建时间）
ExpireTime (int) - 证书内容的过期时间
Fingerprint (str) - 证书指纹
Name (str) - 证书名
Privatekey (str) - 私钥内容
Region (str) - 地域
Remark (str) - 证书描述
SubjectAlternativeNames (list) - 备域名
VSInfos (list) - 见 BindVSInfo 模型定义
Zone (str) - 可用区

describe_disk(req=None, **kwargs)[source]¶

DescribeDisk - 获取硬盘信息

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
DiskIDs (list) - 【数组】磁盘的 ID。输入有效的 ID。调用方式举例：DiskIDs.0=“one-id”、DiskIDs.1=“two-id”。
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。

Response

Infos (list) - 见 DiskInfo 模型定义
Message (str) - 返回信息描述。
TotalCount (int) - 返回磁盘总个数。

Response Model

DiskInfo

AttachResourceID (str) - 绑定资源ID
ChargeType (str) - 硬盘计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
CreateTime (int) - 创建时间。时间戳
DiskID (str) - 硬盘ID
DiskStatus (str) - 硬盘状态。Creating：创建中,BeingCloned：正在被克隆中,Unbound：已解绑,Unbounding：解绑中,Bounding：绑定中,Bound：已绑定,Upgrading：升级中,Deleting：删除中,Deleted：已删除,Releasing：销毁中,Released：已销毁
ExpireTime (int) - 过期时间。时间戳
Name (str) - 名称
Region (str) - 地域
Remark (str) - 备注
SetType (str) - 磁盘类型。例如：Normal,SSD
Size (int) - 大小。单位GB
Zone (str) - 可用区

describe_eip(req=None, **kwargs)[source]¶

DescribeEIP - 获取外网IP的信息

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
EIPIDs (list) - 【数组】外网的 ID。输入有效的 ID。调用方式举例：EIPIDs.0=“one-id”、EIPIDs.1=“two-id”
Limit (str) - 返回数据长度，默认为20，最大100。
Offset (str) - 列表起始位置偏移量，默认为0。

Response

Infos (list) - 见 EIPInfo 模型定义
Message (str) - 返回信息描述
Totalcount (int) - 返回现有外网IP总数

Response Model

EIPInfo

Bandwidth (int) - 带宽大小
BindResourceID (str) - 绑定资源ID
BindResourceType (str) - 绑定资源类型
ChargeType (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
CreateTime (int) - 创建时间。时间戳
EIPID (str) - ID
ExpireTime (int) - 过期时间。时间戳
IP (str) - 外网IP
Name (str) - 名称
OperatorName (str) - 线路
Region (str) - 地域
Remark (str) - 备注
Status (str) - 状态。Allocating：申请中,Free：未绑定,Bounding：绑定中,Bound：已绑定,Unbounding：解绑中,Deleted：已删除,Releasing：销毁中,Released：已销毁,BandwidthChanging：带宽修改中
Zone (str) - 可用区

describe_image(req=None, **kwargs)[source]¶

DescribeImage - 获取镜像信息，包括默认镜像和自制镜像。

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
ImageIDs (list) - 【数组】镜像的 ID。输入有效的 ID。调用方式举例：ImageIDs.0=“one-id”、ImageIDs.1=“two-id”。
ImageType (str) - 镜像类型。枚举值：Base(基础镜像，平台默认提供的镜像)，Custom(自制镜像，通过虚拟机导出的镜像) 。若该值为空，默认查询所有镜像。
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。

Response

Action (str) - 操作名称
Infos (list) - 见 ImageInfo 模型定义
Message (str) - 返回信息描述。
RetCode (int) - 返回码
TotalCount (int) - 返回镜像的总个数。

Response Model

ImageInfo

CreateTime (int) - 创建时间。时间戳。
ImageID (str) - 镜像ID
ImageStatus (str) - 镜像状态。枚举类型：Making（创建中）,Available（可用）,Unavailable（不可用）,Terminating（销毁中）,Used（被使用中）,Deleting（删除中）,Deleted（已删除）, Uploading（导入中）
ImageType (str) - 镜像类型。枚举类型：Base(基础镜像),Custom（自制镜像）。
Name (str) - 镜像名称
OSDistribution (str) - 镜像系统发行版本。例如：Centos, Ubuntu, Windows等
OSName (str) - 系统名称。例如：CentOS 7.4 x86_64
OSType (str) - 系统类型。例如：Linux, Windows，Kylin
Region (str) - 地域
SetArch (str) - 架构名称。例如：x86_64
Zone (str) - 可用区

describe_lb(req=None, **kwargs)[source]¶

DescribeLB - 获取负载均衡信息

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
LBIDs (list) - 【数组】负载均衡的 ID。调用方式举例：LBIDs.0=“one-id”、LBIDs.1=“two-id”。
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
SubnetID (str) - 子网ID
VPCID (str) - VPCID

Response

Infos (list) - 见 LBInfo 模型定义
Message (str) - 返回信息描述。
TotalCount (int) - 返回负载均衡总个数。

Response Model

LBInfo

AlarmTemplateID (str) - 告警模板ID
ChargeType (str) - 虚拟机计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
CreateTime (int) - 创建时间，时间戳
ExpireTime (int) - 过期时间，时间戳
LBID (str) - 负载均衡ID
LBStatus (str) - 状态。Creating:创建中,Running:运行中,Deleting:删除中,Deleted:已删除
LBType (str) - 负载均衡类型，枚举值，WAN:外网负载均衡，LAN:内网负载均衡。
Name (str) - 名称
PrivateIP (str) - 负载均衡的内网 IP 地址，当LB为外网类型时，该值为空。
PublicIP (str) - 负载均衡的外网 IP 地址，当LB为内网类型时，该值为空。
Region (str) - 地域
Remark (str) - 描述
SGID (str) - 安全组 ID ，当LB为内网类型时，该值为空。
SubnetID (str) - 子网ID
VPCID (str) - VPCID
VSCount (int) - VServer的数量
Zone (str) - 可用区

describe_metric(req=None, **kwargs)[source]¶

DescribeMetric - 获取资源监控信息

Request

Region (str) - (Config) 地域。枚举值：cn，表示中国；
BeginTime (str) - (Required) 开始时间。使用unix时间戳
EndTime (str) - (Required) 结束时间。使用Unix时间戳
MetricName (list) - (Required) 监控指标。1. 获取虚拟机监控信息调用举例，MetricName.0=”CPUUtilization”、MetricName.0=”MemUsage”。虚拟机监控指标枚举值：BlockProcessCount，表示阻塞进程数；CPUUtilization，表示CPU使用率；DiskReadOps，表示磁盘读次数；DiskWriteOps，表示磁盘写次数；IORead，表示磁盘读吞吐；IOWrite，表示磁盘写吞吐；LoadAvg，表示平均负载1分钟；MemUsage，表示内存使用率；NetPacketIn，表示网卡入包量；NetPacketOut，表示网卡出包量；NICIn，表示网卡入带宽；NICOut，表示网卡出带宽；SpaceUsage，表示空间使用率；TCPConnectCount，表示TCP连接数；2. EIP监控指标：NetPacketIn：入包量；NetPacketOut：出包量；NICIn：入带宽；NICOut：出带宽；NICOutUsage：出带宽使用率；
ResourceID (str) - (Required) 资源ID
ResourceType (str) - (Required) 资源类型。VM：虚拟机；EIP：弹性IP
Zone (str) - (Required) 可用区。枚举值：zone-01，中国；

Response

Infos (list) - 见 MetricInfo 模型定义
Message (str) - 返回信息描述
TotalCount (int) - 返回监控信息条数

Response Model

MetricSet

Timestamp (int) - 监控时间
Value (float) - 监控值

MetricInfo

Infos (list) - 见 MetricSet 模型定义
MetricName (str) - 监控指标。虚拟机的监控指标枚举值为：BlockProcessCount，表示阻塞进程数；CPUUtilization，表示CPU使用率；DiskReadOps，表示磁盘读次数；DiskWriteOps，表示磁盘写次数；IORead，表示磁盘读吞吐；IOWrite，表示磁盘写吞吐；LoadAvg，表示平均负载1分钟；MemUsage，表示内存使用率；NetPacketIn，表示网卡入包量；NetPacketOut，表示网卡出包量；NICIn，表示网卡入带宽；NICOut，表示网卡出带宽；SpaceUsage，表示空间使用率；TCPConnectCount，表示TCP连接数；

describe_natgw(req=None, **kwargs)[source]¶

DescribeNATGW - 获取NAT网关信息

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Limit (int) - 返回数据长度，默认为20，最大100。
NATGWIDs (list) - 【数组】NAT网关的 ID。调用方式举例：NATGWIDs.0=“one-id”、NATGWIDs.1=“two-id”。
Offset (int) - 列表起始位置偏移量，默认为0。

Response

Infos (list) - 见 NATGWInfo 模型定义
Message (str) - 返回信息描述。
TotalCount (int) - 返回NAT网关总个数

Response Model

NATGWInfo

AlarmTemplateID (str) - 告警模板ID
ChargeType (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
CreateTime (int) - 创建时间，时间戳
EIP (str) - 虚拟IP
ExpireTime (int) - 过期时间，时间戳
NATGWID (str) - NAT网关ID
NATGWStatus (str) - 状态。Creating:创建中, Running:运行中, Deleting:删除中, Deleted:已删除
Name (str) - 名称
Region (str) - 地域
Remark (str) - 备注
SGID (str) - NAT网关绑定的安全组ID
SubnetID (str) - NAT网关实例所在的子网 ID
VPCID (str) - NAT网关实例所在的 VPC ID
Zone (str) - 可用区

describe_natgw_rule(req=None, **kwargs)[source]¶

DescribeNATGWRule - 获取NAT网关白名单信息

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
NATGWID (str) - (Required) NAT网关ID
NATGWType (str) - (Required) NAT类型。枚举值：SNAT，DNAT
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
BindResourceIDs (list) - 【数组】NAT网关白名单资源ID。调用方式举例：NATGWRules.0=“one-id”、NATGWRules.1=“two-id”。
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
RuleIDs (list) - 【数组】NAT网关白名单ID。调用方式举例：NATGWRules.0=“one-id”、NATGWRules.1=“two-id”。

Response

Infos (list) - 见 NATGWRuleInfo 模型定义
Message (str) - 返回信息描述。
TotalCount (int) - 返回NAT网关白名单资源总个数。

Response Model

NATGWRuleInfo

BindResourceID (str) - 绑定的资源ID
BindResourceType (str) - 绑定资源的类型
CreateTime (int) - 创建时间，时间戳。
IP (str) - 白名单资源的内网IP地址
NATGWID (str) - NAT网关ID
NATGWType (str) - nat网关类型
Name (str) - 添加的白名单资源名称
RuleID (str) - 白名单ID
RuleStatus (str) - 状态。Bounding:绑定中,Bound:已绑定,Unbounding:解绑中,Unbound：已解绑

describe_op_logs(req=None, **kwargs)[source]¶

DescribeOPLogs - 查询操作日志

Request

Region (str) - (Config) 地域。参见地域和可用区列表
BeginTime (int) - (Required) 开始时间
EndTime (int) - (Required) 结束时间
Zone (str) - (Required) 可用区。参见可用区列表
IsSuccess (str) - 是否操作成功
Limit (int) -
Offset (int) -
ResourceID (str) - 资源ID
ResourceType (str) - 资源类型

Response

Infos (list) - 见 OPLogInfo 模型定义
Message (str) - 错误信息
TotalCount (int) - 总数

Response Model

OPLogInfo

CreateTime (int) - 创建时间
IsSuccess (str) - 是否操作成功， Yes, No
OPLogsID (str) - 日志ID
OPName (str) - API
OPTime (int) - 操作时间
OpMessage (str) - 错误信息
Region (str) -
ResourceID (str) - 资源ID
ResourceType (int) - 资源类型
RetCode (int) - 状态码
UserEmail (str) - 账号邮箱
Zone (str) -

describe_physical_ip(req=None, **kwargs)[source]¶

DescribePhysicalIP - 获取物理IP信息

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Limit (str) - 返回数据长度，默认为20，最大100。
Offset (str) - 列表起始位置偏移量，默认为0。
PhysicalIPIDs (list) - 【数组】物理IP的 ID。输入有效的 ID。调用方式举例：PhysicalIPIDs.0=“one-id”、PhysicalIPIDs.1=“two-id”

Response

Infos (list) - 见 PhysicalIPInfo 模型定义
Message (str) - 返回信息描述
TotalCount (int) - 返回现有物理IP总数

Response Model

PhysicalIPInfo

BindResourceID (str) - 绑定资源ID
BindResourceType (str) - 绑定资源类型
CreateTime (int) - 创建时间。时间戳
IP (str) - 物理IP
Name (str) - 名称
OperatorName (str) - 线路
PhysicalIPID (str) - 物理IP的ID
Region (str) - 地域
Remark (str) - 备注
Status (str) - 状态。Allocating：申请中,Free：未绑定,Bounding：绑定中,Bound：已绑定,Unbounding：解绑中,Deleted：已删除,Releasing：销毁中,Released：已销毁
UpdateTime (int) - 过期时间。时间戳
Zone (str) - 可用区

describe_recycled_resource(req=None, **kwargs)[source]¶

DescribeRecycledResource - 查询回收站资源

Request

Region (str) - (Config) 地域。枚举值：如 cn,表示中国。
Zone (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
ResourceIDs (list) - 【数组】资源ID，输入“有效”的ID。调用方式举例：ResourceIDs.0=“one-id”、ResourceIDs.1=“two-id”。

Response

Infos (list) - 见 RecycledResourceInfo 模型定义
TotalCount (int) - 返回回收站资源的总个数

Response Model

RecycledResourceInfo

CreateTime (int) - 创建时间
DeleteTime (int) - 删除时间
Description (str) - 描述
ExpireTime (int) - 过期时间
IsAutoTerminated (bool) - 是否自动销户
Name (str) - 名称
Region (str) - 地域
ResourceID (str) - 资源ID
ResourceType (str) - 资源类型：VM:虚拟机，Disk:硬盘，EIP:外网IP，PIP:物理IP，MySQL:数据库，Redis:缓存
Status (str) - 资源状态
WillTerminateTime (int) - 销毁时间
Zone (str) - 可用区

describe_rs(req=None, **kwargs)[source]¶

DescribeRS - 获取负载均衡服务的服务节点信息

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
LBID (str) - (Required) 负载均衡ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
RSIDs (list) - 【数组】RServer的 ID。调用方式举例：RSIDs.0=“one-id”、RSIDs.1=“two-id”。
VSID (str) - VServer的ID

Response

Infos (list) - 见 RSInfo 模型定义
Message (str) - 返回信息描述。
TotalCount (int) - 返回该负载均衡下VServer的总个数。

Response Model

RSInfo

BindResourceID (str) - 绑定的资源ID
CreateTime (int) - 创建时间，时间戳
IP (str) - 服务节点的内网 IP 地址
LBID (str) - 服务节点所属的负载均衡 ID
Name (str) - 服务节点的资源名称
Port (int) - 服务节点暴露的服务端口号
RSID (str) - 服务节点的 ID
RSMode (str) - 节点模式。枚举值，Enabling:开启中,Enable:已启用,Disabling:禁用中,Disable:已禁用
RSStatus (str) - RSStatus 的描述修改为：状态，枚举值，Creating:创建中,Inactive:无效,Active:有效,Updating:更新中,Deleting:删除中,Deleted:已删除。其中有效代表节点服务健康，无效代表节点服务异常。
UpdateTime (int) - 更新时间，时间戳
VSID (str) - 服务节点所属的 VServer ID
Weight (int) - 服务节点的权重

describe_security_group(req=None, **kwargs)[source]¶

DescribeSecurityGroup - 查询安全组信息

Request

Region (str) - (Config) 地域。
Zone (str) - (Required) 可用区。
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
SGIDs (list) - 【数组】安全组的 ID。输入有效的 ID。调用方式举例：SGIDs.0=“one-id”、SGIDs.1=“two-id”

Response

Infos (list) - 见 SGInfo 模型定义
Message (str) - 返回信息描述；
TotalCount (int) - 安全组的总数

Response Model

SGRuleInfo

DstPort (str) - 端口号
IsIn (str) - 方向。1：入，0：出
Priority (str) - 优先级。HIGH:高，MEDIUM:中，LOW:低
ProtocolType (str) - 协议
RuleAction (str) - 动作。ACCEPT：接受，DROP：拒绝
RuleID (str) - 规则ID
SrcIP (str) - IP或者掩码/段形式。10.0.0.2,10.0.10.10/16

SGInfo

CreateTime (int) - 创建时间，时间戳
Name (str) - 名称
Region (str) - 地域
Remark (str) - 描述
ResourceCount (int) - 资源绑定数量
Rule (list) - 见 SGRuleInfo 模型定义
RuleCount (int) - 规则数量
SGID (str) - 安全组ID
Status (str) - 状态。Creating：创建中,Updating：更新中,Available：有效,Deleted：已删除,Terminating：销毁中,Terminated：已销毁
UpdateTime (int) - 更新时间，时间戳
Zone (str) - 可用区

describe_storage_type(req=None, **kwargs)[source]¶

DescribeStorageType - 查询存储类型

Request

Region (str) - (Config) 地域。
Zone (str) - (Required) 可用区。

Response

Infos (list) - 见 StorageTypeInfo 模型定义
Message (str) - 返回信息描述；
TotalCount (int) - 存储类型的总数

Response Model

StorageTypeInfo

Region (str) - 地域
SetArch (str) - 架构
StorageType (str) - 存储类型
StorageTypeAlias (str) - 存储类型别名
Zone (str) - 可用区

describe_subnet(req=None, **kwargs)[source]¶

DescribeSubnet - 查询子网信息

Request

Region (str) - (Config) 地域。
Zone (str) - (Required) 可用区。
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
SubnetIDs (list) - 【数组】子网 ID。调用方式举例：SubnetIDs.0=“one-id”、SubnetIDs.1=“two-id”
VPCID (str) - VPCID

Response

Infos (list) - 见 SubnetInfo 模型定义
Message (str) - 返回信息描述；
TotalCount (int) - 子网的总数

Response Model

SubnetInfo

CreateTime (int) - 创建时间，时间戳
Name (str) - 名称
Network (str) - 网段
Region (str) - 地域
Remark (str) - 描述
State (str) - 状态；Allocating：申请中,Available：有效,Deleting：删除中,Deleted：已删除
SubnetID (str) - ID
UpdateTime (int) - 更新时间，时间戳
Zone (str) - 可用区

describe_user(req=None, **kwargs)[source]¶

DescribeUser - 查询租户信息

Request

Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
UserIDs (list) - 【数组】租户的 ID。输入有效的 ID。调用方式举例：UserIDs.0=123”、UserIDs.1=456

Response

Infos (list) - 见 UserInfo 模型定义
Message (str) - 返回信息描述
TotalCount (int) - 返回现有租户总数

Response Model

UserInfo

Amount (float) - 账户余额
CreateTime (int) - 账户创建时间。时间戳
Email (str) - 租户名称
PrivateKey (str) - 私钥
PublicKey (str) - 公钥
Status (str) - 用户状态。USER_STATUS_AVAILABLE：正常，USER_STATUS_FREEZE：冻结
UpdateTime (int) - 更新时间。时间戳
UserID (int) - 租户ID.

describe_vm_instance(req=None, **kwargs)[source]¶

DescribeVMInstance - 查询虚拟机

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (str) - 列表起始位置偏移量，默认为0。
SubnetID (str) - 子网 ID。输入“有效”状态的子网 ID。
VMIDs (list) - 【数组】虚拟机的 ID。输入有效的 ID。调用方式举例：PrivateIp.0=“one-id”、PrivateIp.1=“two-id”。
VPCID (str) - VPC ID。输入“有效”状态的VPC ID。

Response

Infos (list) - 见 VMInstanceInfo 模型定义
Message (str) - 返回信息描述
TotalCount (int) - 返回虚拟机总个数

Response Model

VMIPInfo

IP (str) - IP 值
IPVersion (str) - IP版本,支持值：IPv4IPv6
InterfaceID (str) - 网卡 ID
IsElastic (str) - 是否是弹性网卡。枚举值：Y，表示是；N，表示否；
MAC (str) - MAC 地址值
SGID (str) - 安全组 ID
SGName (str) - 安全组名称
SubnetID (str) - 子网 ID
SubnetName (str) - 子网名称
Type (str) - IP 类型。枚举值：Private，表示内网；Public，表示外网；Physical，表示物理网；
VPCID (str) - VPC ID
VPCName (str) - VPC 名称

VMDiskInfo

DiskID (str) - 磁盘 ID
Drive (str) - 磁盘盘符
IsElastic (str) - 是否是弹性磁盘。枚举值为：Y，表示是；N，表示否；
Name (str) - 磁盘名称
Size (int) - 磁盘大小，单位 GB
Type (str) - 磁盘类型。枚举值：Boot，表示系统盘；Data，表示数据盘；

VMInstanceInfo

CPU (int) - CPU 个数
ChargeType (str) - 虚拟机计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
CreateTime (int) - 虚拟机创建时间
DiskInfos (list) - 见 VMDiskInfo 模型定义
ExpireTime (int) - 虚拟机过期时间
IPInfos (list) - 见 VMIPInfo 模型定义
ImageID (str) - 镜像 ID
Memory (int) - 内存大小，单位 M
Name (str) - 虚拟机名称
OSName (str) - 操作系统名称
OSType (str) - 操作系统类型
Region (str) - Region
RegionAlias (str) - Region 别名
Remark (str) - 备注
State (str) - 虚拟机状态。枚举值：Initializing，表示初始化；Starting，表示启动中；Restarting，表示重启中；Running，表示运行；Stopping，表示关机中；Stopped，表示关机；Deleted，表示已删除；Resizing，表示修改配置中；Terminating，表示销毁中；Terminated，表示已销毁；Migrating，表示迁移中；WaitReinstall，表示等待重装系统；Reinstalling，表示重装中；Poweroffing，表示断电中；ChangeSGing，表示修改防火墙中；
SubnetID (str) - 子网 ID
SubnetName (str) - 子网名称
VMID (str) - 虚拟机 ID
VMType (str) - 虚拟机类型
VMTypeAlias (str) - 虚拟机类型别名
VPCID (str) - VPC ID
VPCName (str) - VPC 名称
Zone (str) - Zone
ZoneAlias (str) - Zone 别名

describe_vm_type(req=None, **kwargs)[source]¶

DescribeVMType - 查询主机机型

Request

Region (str) - (Config) 地域。
Zone (str) - (Required) 可用区。

Response

Infos (list) - 见 VMTypeInfo 模型定义
Message (str) - 返回信息描述；
TotalCount (int) - 主机机型的总数

Response Model

VMTypeInfo

Region (str) - 地域
SetArch (str) - 架构
VMType (str) - 机型
VMTypeAlias (str) - 机型别名
Zone (str) - 可用区

describe_vpc(req=None, **kwargs)[source]¶

DescribeVPC - 查询VPC信息

Request

Region (str) - (Config) 地域。
Zone (str) - (Required) 可用区。
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
VPCIDs (list) - 【数组】VPC的 ID。调用方式举例：VPCIDs.0=“one-id”、VPCIDs.1=“two-id”

Response

Infos (list) - 见 VPCInfo 模型定义
Message (str) - 返回信息描述；
TotalCount (int) - VPC的总数

Response Model

SubnetInfo

CreateTime (int) - 创建时间，时间戳
Name (str) - 名称
Network (str) - 网段
Region (str) - 地域
Remark (str) - 描述
State (str) - 状态；Allocating：申请中,Available：有效,Deleting：删除中,Deleted：已删除
SubnetID (str) - ID
UpdateTime (int) - 更新时间，时间戳
Zone (str) - 可用区

VPCInfo

CreateTime (int) - 创建时间，时间戳
Name (str) - 名称
Network (str) - 网段，比如10.0.0.0/16
Region (str) - 地域。
Remark (str) - 描述
State (str) - 状态；Allocating：申请中,Available：有效,Terminating：销毁中,Terminated：已销毁
SubnetCount (int) - 该VPC下拥有的子网数目
SubnetInfos (list) - 见 SubnetInfo 模型定义
UpdateTime (int) - 修改时间，时间戳
VPCID (str) - VPC的ID
Zone (str) - 可用区

describe_vs(req=None, **kwargs)[source]¶

DescribeVS - 获取负载均衡 VServer 信息

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
LBID (str) - (Required) 负载均衡ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
VSIDs (list) - 【数组】VServer的 ID。调用方式举例：VSIDs.0=“one-id”、VSIDs.1=“two-id”。

Response

Infos (list) - 见 VSInfo 模型定义
Message (str) - 返回信息描述。
TotalCount (int) - 返回当前负载均衡 VServer 总个数。

Response Model

VSPolicyInfo

CreateTime (int) - 创建时间，时间戳
Domain (str) - 内容转发规则关联的请求域名，值可为空，即代表仅匹配路径。
LBID (str) - 负载均衡ID
Path (str) - 内容转发规则关联的请求访问路径，如 “/” 。
PolicyID (str) - 内容转发规则ID
PolicyStatus (str) - 状态，枚举值，Available:有效,Deleted:已删除
RSInfos (list) - 见 RSInfo 模型定义
UpdateTime (int) - 更新时间，时间戳
VSID (str) - VServerID

RSInfo

BindResourceID (str) - 绑定的资源ID
CreateTime (int) - 创建时间，时间戳
IP (str) - 服务节点的内网 IP 地址
LBID (str) - 服务节点所属的负载均衡 ID
Name (str) - 服务节点的资源名称
Port (int) - 服务节点暴露的服务端口号
RSID (str) - 服务节点的 ID
RSMode (str) - 节点模式。枚举值，Enabling:开启中,Enable:已启用,Disabling:禁用中,Disable:已禁用
RSStatus (str) - RSStatus 的描述修改为：状态，枚举值，Creating:创建中,Inactive:无效,Active:有效,Updating:更新中,Deleting:删除中,Deleted:已删除。其中有效代表节点服务健康，无效代表节点服务异常。
UpdateTime (int) - 更新时间，时间戳
VSID (str) - 服务节点所属的 VServer ID
Weight (int) - 服务节点的权重

VSInfo

AlarmTemplateID (str) - 告警模板ID
CreateTime (int) - 创建时间，时间戳
Domain (str) - HTTP 健康检查时校验请求的 HOST 字段中的域名。当健康检查类型为端口检查时，该值为空。
HealthcheckType (str) - 负载均衡的健康检查类型。枚举值：Port:端口检查；Path: HTTP检查。
KeepaliveTimeout (int) - 负载均衡的连接空闲超时时间，单位为秒，默认值为 60s 。当 VServer 协议为 UDP 时，该值为空。
LBID (str) - VServer 所属的负载均衡 ID
Path (str) - HTTP 健康检查的路径。当健康检查类型为端口检查时，该值为空。
PersistenceKey (str) - 会话保持KEY，仅当 VServer 协议为 HTTP 且会话保持为手动时有效。
PersistenceType (str) - 会话保持类型。枚举值：None:关闭；Auto:自动生成；Manual:手动生成。当协议为 TCP 时，该值为空；当协议为 UDP 时 Auto 表示开启会话保持。
Port (int) - 端口
Protocol (str) - 协议
RSHealthStatus (str) - 健康检查状态，枚举值，Empty:全部异常,Parts:部分异常,All:正常
RSInfos (list) - 见 RSInfo 模型定义
UpdateTime (int) - 更新时间，时间戳
VSID (str) - VServer的ID
VSPolicyInfos (list) - 见 VSPolicyInfo 模型定义
VSStatus (str) - VServer 的资源状态。枚举值，Available:可用,Updating:更新中,Deleted:已删除。

describe_vs_policy(req=None, **kwargs)[source]¶

DescribeVSPolicy - 获取七层负载均衡内容转发规则信息，仅当 VServer 的监听协议为 HTTP 时有效。

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
LBID (str) - (Required) 负载均衡ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Limit (int) - 返回数据长度，默认为20，最大100。
Offset (int) - 列表起始位置偏移量，默认为0。
PolicyIDs (list) - 【数组】七层负载均衡内容转发规则的 ID。调用方式举例：PolicyIDs.0=“one-id”、PolicyIDs.1=“two-id”
VSID (str) - VServerID

Response

Infos (list) - 见 VSPolicyInfo 模型定义
Message (str) - 返回信息描述。
TotalCount (int) - 返回内容转发规则的总个数。

Response Model

RSInfo

BindResourceID (str) - 绑定的资源ID
CreateTime (int) - 创建时间，时间戳
IP (str) - 服务节点的内网 IP 地址
LBID (str) - 服务节点所属的负载均衡 ID
Name (str) - 服务节点的资源名称
Port (int) - 服务节点暴露的服务端口号
RSID (str) - 服务节点的 ID
RSMode (str) - 节点模式。枚举值，Enabling:开启中,Enable:已启用,Disabling:禁用中,Disable:已禁用
RSStatus (str) - RSStatus 的描述修改为：状态，枚举值，Creating:创建中,Inactive:无效,Active:有效,Updating:更新中,Deleting:删除中,Deleted:已删除。其中有效代表节点服务健康，无效代表节点服务异常。
UpdateTime (int) - 更新时间，时间戳
VSID (str) - 服务节点所属的 VServer ID
Weight (int) - 服务节点的权重

VSPolicyInfo

CreateTime (int) - 创建时间，时间戳
Domain (str) - 内容转发规则关联的请求域名，值可为空，即代表仅匹配路径。
LBID (str) - 负载均衡ID
Path (str) - 内容转发规则关联的请求访问路径，如 “/” 。
PolicyID (str) - 内容转发规则ID
PolicyStatus (str) - 状态，枚举值，Available:有效,Deleted:已删除
RSInfos (list) - 见 RSInfo 模型定义
UpdateTime (int) - 更新时间，时间戳
VSID (str) - VServerID

detach_disk(req=None, **kwargs)[source]¶

DetachDisk - 解绑UClouStack硬盘

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
DiskID (str) - (Required) 硬盘ID
ResourceID (str) - (Required) 绑定的资源ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

disable_rs(req=None, **kwargs)[source]¶

DisableRS - 禁用负载均衡的单个服务节点

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) 负载均衡ID
RSID (str) - (Required) RServer的ID
VSID (str) - (Required) VServer的ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

enable_rs(req=None, **kwargs)[source]¶

EnableRS - 启用负载均衡的单个服务节点

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) 负载均衡ID
RSID (str) - (Required) RServer的ID
VSID (str) - (Required) VServer的ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

get_disk_price(req=None, **kwargs)[source]¶

GetDiskPrice - 获取硬盘价格

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
ChargeType (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
DiskSpace (int) - (Required) 磁盘大小
SetType (str) - (Required) 磁盘类型
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Quantity (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。

Response

Infos (list) - 见 PriceInfo 模型定义
Message (str) - 返回信息描述。

Response Model

PriceInfo

ChargeType (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
Price (float) - 价格

get_eip_price(req=None, **kwargs)[source]¶

GetEIPPrice - 获取外网IP价格

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
Bandwidth (int) - (Required) 带宽，默认值1，默认范围1~100
ChargeType (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
OpertatorName (str) - (Required) 线路。目前支持Bgp
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Quantity (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。

Response

Infos (list) - 见 PriceInfo 模型定义
Message (str) - 返回信息描述

Response Model

PriceInfo

ChargeType (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
Price (float) - 价格

get_vm_instance_price(req=None, **kwargs)[source]¶

GetVMInstancePrice - 获取虚拟机价格

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
BootDiskSetType (str) - (Required) 系统盘类型。枚举值：Normal，表示普通；SSD，表示SSD；
CPU (int) - (Required) CPU 个数，目前只能输入数据库配置指定规格参数，如：1核2048M、2核4096M、4核8192M、8核16384M、16核32768M。
ChargeType (str) - (Required) 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
DataDiskSetType (str) - (Required) 数据盘类型。枚举值：Normal，表示普通；SSD，表示SSD；
DataDiskSpace (int) - (Required) 数据盘大小，单位 GB。默认值为0。范围：【0，8000】，步长10。
ImageID (str) - (Required) 镜像 ID。基础镜像 ID 或者自制镜像 ID。如：cn-image-centos-74。
Memory (int) - (Required) 内存大小，单位 M。目前只能输入数据库配置指定规格参数，如：1核2048M、2核4096M、4核8192M、8核16384M、16核32768M。
OSType (str) - (Required) 系统类型。
VMType (str) - (Required) 机型。枚举值：Normal，表示普通；SSD，表示SSD；
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
GPU (int) - GPU 卡核心的占用个数。枚举值：【1,2,4】。GPU与CPU、内存大小关系：CPU个数>=4*GPU个数，同时内存与CPU规格匹配.
Quantity (int) - 购买时长。默认值1。小时不生效，月范围【1，11】，年范围【1，5】。

Response

Infos (list) - 见 PriceInfo 模型定义
Message (str) - 返回信息描述。

Response Model

PriceInfo

ChargeType (str) - 计费模式。枚举值：Dynamic，表示小时；Month，表示月；Year，表示年；
Price (float) - 价格

modify_eip_bandwidth(req=None, **kwargs)[source]¶

ModifyEIPBandwidth - 调整外网IP带宽

Request

Region (str) - (Config) 地域。
Bandwidth (int) - (Required) 调整后的带宽
EIPID (str) - (Required) 外网IP的ID
Zone (str) - (Required) 可用区。

Response

Message (str) - 返回信息描述；

modify_name_and_remark(req=None, **kwargs)[source]¶

ModifyNameAndRemark - 修改资源名称和备注

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Name (str) - (Required) 名称;
ResourceID (str) - (Required) 资源ID;
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Remark (str) - 描述;

Response

Message (str) - 返回信息描述

poweroff_vm_instance(req=None, **kwargs)[source]¶

PoweroffVMInstance - 断电虚拟机，可能导致丢失数据甚至损坏操作系统，仅适用于虚拟机死机及级端测试场景。

Request

Region (str) - (Config) 地域。枚举值：如 cn,表示中国。
VMID (str) - (Required) 虚拟机ID
Zone (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。

Response

Message (str) - 返回信息描述

recharge(req=None, **kwargs)[source]¶

Recharge - 管理员给租户充值

Request

Amount (int) - (Required) 充值金额。最少100,最大500000
FromType (str) - (Required) 充值来源。INPOUR_FROM_ALIPAY：支付宝，INPOUR_FROM_OFFLINE：银行转账，INPOUR_FROM_SINPAY：新浪支付，INPOUR_FROM_WECHAT_PAY：微信转账。
SerialNo (str) - (Required) 充值单号。充值方式为“账户余额”时为必要参数。
UserID (int) - (Required) 租户的账户ID。

Response

Message (str) - 返回信息描述。

reinstall_vm_instance(req=None, **kwargs)[source]¶

ReinstallVMInstance - 重装系统，关机的虚拟机才可以重装系统

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
ImageID (str) - (Required) 镜像ID
VMID (str) - (Required) 虚拟机ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述

release_eip(req=None, **kwargs)[source]¶

ReleaseEIP - 删除外网IP

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；中国
EIPID (str) - (Required) 外网IP的ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国

Response

Message (str) - 返回状态描述

renew_resource(req=None, **kwargs)[source]¶

RenewResource - 续费回收站资源

Request

Region (str) - (Config) 地域。枚举值：如 cn,表示中国。
ResourceID (str) - (Required) 待续续的资源ID
Zone (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。
Quantity (int) - 购买时长，默认为 1。按小时(Dynamic)付费的资源无需此参数，按月付费的资源传 0 时，代表购买至月末。

Response

Message (str) - 返回描述信息

reset_vm_instance_password(req=None, **kwargs)[source]¶

ResetVMInstancePassword - 重置虚拟机密码，主机必须开机才可以重置密码

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Password (str) - (Required) 密码
VMID (str) - (Required) 虚拟机ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述

resize_vm_config(req=None, **kwargs)[source]¶

ResizeVMConfig - 修改虚拟机配置

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
CPU (int) - (Required) CPU 个数，如 1、2、4、8、16、32、64。
Memory (int) - (Required) 内存容量，如 2048、4096、8192、16384、32768、65536、131072。
VMID (str) - (Required) 虚拟机ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述

restart_vm_instance(req=None, **kwargs)[source]¶

RestartVMInstance - 重启虚拟机

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
VMID (str) - (Required) 虚拟机ID;
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述

rollback_resource(req=None, **kwargs)[source]¶

RollbackResource - 恢复回收站资源

Request

Region (str) - (Config) 地域。枚举值：如 cn,表示中国。
ResourceID (str) - (Required) 待恢复的资源ID
Zone (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。

Response

Message (str) - 返回描述信息

rollback_snapshot(req=None, **kwargs)[source]¶

RollbackSnapshot - 将某个快照内的数据回滚到原云硬盘，仅支持正常状态的快照进行回滚操作，回滚时硬盘必须处于未绑定或其挂载的主机为关机状态。

Request

Region (str) - (Config) 地域。枚举值：如 cn,表示中国。
DiskID (str) - (Required) 对应的云硬盘 ID；
SnapshotID (str) - (Required) 快照ID
Zone (str) - (Required) 可用区。枚举值：如 zone-01，表示可用区1。

Response

Message (str) - 返回信息描述

start_vm_instance(req=None, **kwargs)[source]¶

StartVMInstance - 开启虚拟机

Request

Region (str) - (Config) 地域。枚举值：cn，表示中国；
VMID (str) - (Required) 虚拟机 ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述

stop_vm_instance(req=None, **kwargs)[source]¶

StopVMInstance - 关闭虚拟机

Request

Region (str) - (Config) 地域。枚举值：cn，表示中国；
VMID (str) - (Required) 虚拟机 ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述
VMID (str) - 虚拟机 ID

terminate_resource(req=None, **kwargs)[source]¶

TerminateResource - 销毁资源

Request

Region (str) - (Config) 地域。
ResourceID (str) - (Required) 资源id
Zone (str) - (Required) 可用区。

Response

Message (str) - 返回描述信息

un_bind_eip(req=None, **kwargs)[source]¶

UnBindEIP - 解绑外网IP

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；中国
EIPID (str) - (Required) 外网IP的ID
ResourceID (str) - (Required) 资源ID
ResourceType (str) - (Required) 资源类型。VM：虚拟机, LB:负载均衡, NATGW：nat网关
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

un_bind_security_group(req=None, **kwargs)[source]¶

UnBindSecurityGroup - 解绑安全组

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
ResourceID (str) - (Required) 解绑的资源ID。调用方式举例：ResourceID=“one-id”。
SGID (str) - (Required) 安全组ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述

unbind_alarm_template(req=None, **kwargs)[source]¶

UnbindAlarmTemplate - 解绑告警模板

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
AlarmTemplateID (str) - (Required) 告警模板ID
ResourceIDs (list) - (Required) 【数组】资源的 ID。调用方式举例：ResourceIDs.0=“one-id”、ResourceIDs.1=“two-id”。
ResourceType (str) - (Required) 资源类型。VM：虚拟机, LB:负载均衡, NATGW：nat网关;EIP:弹性网卡
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述

unbind_physical_ip(req=None, **kwargs)[source]¶

UnbindPhysicalIP - 解绑物理IP

Request

Region (str) - (Config) 地域。
PhysicalIPID (str) - (Required) 物理IP的ID
ResourceID (str) - (Required) 资源ID
ResourceType (str) - (Required) 资源类型。VM：虚拟机
Zone (str) - (Required) 可用区。

Response

Message (str) - 返回信息描述。

update_alarm_template_rule(req=None, **kwargs)[source]¶

UpdateAlarmTemplateRule - 更新告警模板规则

Request

Region (str) - (Config) 地域
AlarmStrategy (str) - (Required) 瘦脸策略
AlarmTemplateID (str) - (Required) 告警模板ID
AlarmTemplateRuleID (str) - (Required) 告警规则ID
Compare (str) - (Required) 对比方式
ContactGroupID (str) - (Required) 通知组ID
MetricName (str) - (Required) 监控指标名称
ResourceType (str) - (Required) 资源类型
Threshold (str) - (Required) 告警阈值
TriggerCount (str) - (Required) 连续触发次数
Zone (str) - (Required) 可用区

Response

Message (str) - 返回描述信息

update_rs(req=None, **kwargs)[source]¶

UpdateRS - 修改负载均衡的服务节点

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) VServer 监听器所属的负载均衡 ID
RSID (str) - (Required) RServer的ID
VSID (str) - (Required) RServer所属的VServer的ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Port (int) - 端口号
Weight (int) - 权重

Response

Message (str) - 返回信息描述。

update_security_group_rule(req=None, **kwargs)[source]¶

UpdateSecurityGroupRule - 修改安全组规则

Request

Region (str) - (Config) 地域。枚举值： cn，表示中国；
Rules (list) - (Required) 【数组】规则。输入有效的规则。调用方式举例：Rules.0=“TCP|23|0.0.0.0/0|ACCEPT|HIGH|1”、Rules.1=“TCP|55|0.0.0.0/0|ACCEPT|HIGH|1”
SGID (str) - (Required) 安全组ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述；

update_vs(req=None, **kwargs)[source]¶

UpdateVS - 修改负载均衡VServer

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) VServer 监听器所属的负载均衡 ID
VSID (str) - (Required) 需要更新的VSID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
CACertificateID (str) - CA证书ID，用于验证客户端证书的签名，仅当VServer监听协议为 HTTPS 且 SSLMode 为双向认证时有效。
Domain (str) - HTTP 健康检查时校验请求的 HOST 字段中的域名。当健康检查类型为端口检查时，该值为空。
HealthcheckType (str) - 负载均衡的健康检查类型。枚举值：Port:端口检查；Path: HTTP检查。仅当 VServer 协议类型为 HTTP 时，才可进行 HTTP 检查。
KeepaliveTimeout (int) - 负载均衡的连接空闲超时时间，单位为秒，默认值为 60s 。当 VServer 协议为 UDP 时，该值为空。
Path (str) - HTTP 健康检查的路径，健康检查类型为 HTTP 检查时为必填项。当健康检查类型为端口检查时，该值为空。
PersistenceKey (str) - 会话保持KEY，会话保持类型为Manual时为必填项，仅当 VServer 协议为 HTTP 时有效。
PersistenceType (str) - 会话保持类型。枚举值：None:关闭；Auto:自动生成；Manual:手动生成。当协议为 TCP 时，该值不生效，会话保持和选择的调度算法相关；当协议为 UDP 时 Auto 表示开启会话保持。
Port (int) - VServer 监听端口
SSLMode (str) - SSL认证模式,HTTPS协议下必传,取值范围[“simplex”,”duplex”]分别表示单向认证和双向认证。
Scheduler (str) - 负载均衡的调度算法。枚举值：wrr:加权轮训；least_conn:最小连接数；hash:原地址,四层lb使用。ip_hash:七层lb使用
ServerCertificateID (str) - 服务器证书ID，用于证明服务器的身份，仅当 VServer监听协议为 HTTPS 时有效。

Response

Message (str) - 返回信息描述。

update_vs_policy(req=None, **kwargs)[source]¶

UpdateVSPolicy - 更新七层负载均衡内容转发规则，仅当 VServer 的监听协议为 HTTP 时有效。

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
LBID (str) - (Required) 负载均衡ID
PolicyID (str) - (Required) 内容转发规则ID
VSID (str) - (Required) VServer的ID
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；
Domain (str) - 内容转发规则关联的请求域名，值可为空，即代表仅匹配路径。
Path (str) - 内容转发规则关联的请求访问路径，如 “/” 。
RSIDs (list) - 【数组】RServer的 ID。调用方式举例：RSIDs.0=“one-id”、RSIDs.1=“two-id”。

Response

Message (str) - 返回信息描述。

upgrade_disk(req=None, **kwargs)[source]¶

UpgradeDisk - 升级硬盘

Request

Region (str) - (Config) 地域。枚举值：cn,表示中国；
DiskID (str) - (Required) 硬盘ID
DiskSpace (int) - (Required) 硬盘升级后的容量，不能小于原硬盘容量，单位为 GB 。
Zone (str) - (Required) 可用区。枚举值：zone-01，表示中国；

Response

Message (str) - 返回信息描述。

UFS¶

class ucloud.services.ufs.client.UFSClient(config, transport=None, middleware=None, logger=None)[source]¶

create_ufs_volume(req=None, **kwargs)[source]¶

CreateUFSVolume - 创建文件系统

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ProtocolType (str) - (Required) 文件系统协议，枚举值，NFSv3表示NFS V3协议，NFSv4表示NFS V4协议
Size (int) - (Required) 文件系统大小，单位为GB，最大不超过20T，香港容量型必须为100的整数倍，Size最小为500GB，北京，上海，广州的容量型必须为1024的整数倍，Size最小为1024GB。性能型文件系统Size最小为100GB
StorageType (str) - (Required) 文件系统存储类型，枚举值，Basic表示容量型，Advanced表示性能型
ChargeType (str) - 计费模式，枚举值为： Year，按年付费； Month，按月付费； Dynamic，按需付费（需开启权限）； Trial，试用（需开启权限）默认为Dynamic
CouponId (str) - 使用的代金券id
Quantity (int) - 购买时长默认: 1
Remark (str) - 备注
Tag (str) - 文件系统所属业务组
VolumeName (str) - 文件系统名称

Response

VolumeId (str) - 文件系统ID
VolumeName (str) - 文件系统名称
VolumeStatus (str) - 文件系统挂载点状态

describe_ufs_volume_2(req=None, **kwargs)[source]¶

DescribeUFSVolume2 - 获取文件系统列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 文件列表长度
Offset (int) - 文件列表起始
VolumeId (str) - 文件系统ID

Response

DataSet (list) - 见 UFSVolumeInfo2 模型定义
TotalCount (int) - 文件系统总数

Response Model

UFSVolumeInfo2

CreateTime (int) - 文件系统创建时间（unix时间戳）
ExpiredTime (int) - 文件系统过期时间（unix时间戳）
IsExpired (str) - 是否过期
MaxMountPointNum (int) - 文件系统允许创建的最大挂载点数目
ProtocolType (str) - 文件系统协议，枚举值，NFSv3表示NFS V3协议，NFSv4表示NFS V4协议
Remark (str) - 文件系统备注信息
Size (int) - 文件系统大小，单位GB
StorageType (str) - 文件系统存储类型，枚举值，Basic表示容量型，Advanced表示性能型
Tag (str) - 文件系统所属业务组
TotalMountPointNum (int) - 当前文件系统已创建的挂载点数目
UsedSize (int) - 文件系统当前使用容量，单位GB
VolumeId (str) - 文件系统ID
VolumeName (str) - 文件系统名称

extend_ufs_volume(req=None, **kwargs)[source]¶

ExtendUFSVolume - 文件系统扩容

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 文件系统大小，单位为GB，最大不超过20T，香港容量型必须为100的整数倍，Size最小为500GB，北京，上海，广州的容量型必须为1024的整数倍，Size最小为1024GB。性能型文件系统Size最小为100GB
VolumeId (str) - (Required) 文件系统ID

Response

remove_ufs_volume(req=None, **kwargs)[source]¶

RemoveUFSVolume - 删除UFS文件系统

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
VolumeId (str) - (Required) 文件系统ID

Response

UHub¶

class ucloud.services.uhub.client.UHubClient(config, transport=None, middleware=None, logger=None)[source]¶

create_repo(req=None, **kwargs)[source]¶

CreateRepo - 创建镜像仓库

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
RepoName (str) - (Required) 仓库名称，不可修改
Description (str) - 仓库备注
IsShared (bool) - 镜像仓库是否公开，公开为true、不公开为false;默认为false

Response

Message (str) - 有错误时返回内容

delete_repo(req=None, **kwargs)[source]¶

DeleteRepo - 删除镜像仓库

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
RepoName (str) - (Required) 镜像仓库名称

Response

delete_repo_image(req=None, **kwargs)[source]¶

DeleteRepoImage - 删除镜像

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ImageName (str) - (Required) 镜像名称
RepoName (str) - (Required) 镜像仓库名称
TagName (str) - 不指定tag则删除全部tag

Response

get_image_tag(req=None, **kwargs)[source]¶

GetImageTag - 获取镜像tag

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ImageName (str) - (Required) 镜像名称
RepoName (str) - (Required) 镜像仓库名称
Limit (int) - 每次获取数量，默认为20
Offset (int) - 偏移量，默认0
TagName (str) - 默认不写，如果填写，代表查询该tag，否则查全部tag

Response

TagSet (list) - 见 TagSet 模型定义
TotalCount (int) - tag总数

Response Model

TagSet

TagName (str) - Tag名称
UpdateTime (str) - 镜像更新时间

get_repo(req=None, **kwargs)[source]¶

GetRepo - 获取镜像仓库

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Limit (int) - 数量，默认20
Offset (int) - 偏移量，默认0
Type (str) - private私有仓库，public公共仓库，默认public

Response

RepoSet (list) - 见 RepoSet 模型定义
TotalCount (int) - 总的仓库数量

Response Model

RepoSet

CreateTime (str) - 仓库创建时间
Description (str) - 镜像仓库描述
IsOutSide (str) - 镜像仓库是否外网可以访问，可以为ture,不可以为false
IsShared (str) - 镜像仓库类型,false为私有；true为公有
RepoName (str) - 镜像仓库名称
UpdateTime (str) - 仓库更新时间

get_repo_image(req=None, **kwargs)[source]¶

GetRepoImage - 获取镜像仓库下的镜像

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
RepoName (str) - (Required) 镜像仓库名称
Limit (int) - 显示数量，默认为20
Offset (int) - 偏移量，默认0

Response

ImageSet (list) - 见 ImageSet 模型定义
TotalCount (int) -

Response Model

ImageSet

CreateTime (str) - 创建时间
ImageName (str) - 镜像名称
LatestTag (str) - 最新push的Tag
PullCount (int) - 镜像被下载次数
RepoName (str) - 镜像仓库名称
UpdateTime (str) - 修改时间

update_repo(req=None, **kwargs)[source]¶

UpdateRepo - 更新镜像仓库

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
RepoName (str) - (Required) 镜像仓库名称，不可修改
Description (str) - 备注
IsShared (str) - false设置为私有；true设置为公有。默认false

Response

Message (str) - 错误的时候返回

UCloud SDK Services¶

PathX¶

StepFlow¶

UAccount¶

UCDN¶

UDB¶

UDPN¶

UDisk¶

UHost¶

ULB¶

UMem¶

UNet¶

UPHost¶

USMS¶

VPC¶

IPSecVPN¶

UCloudStack¶

UFS¶

UHub¶

ucloud-sdk-python3

Navigation

Related Topics