UCloud SDK Services¶

PathX¶

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

bind_path_xssl(req: Optional[dict] = None, **kwargs) → dict[source]¶

BindPathXSSL - 绑定PathX SSL证书

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
Port (list) - (Required) 绑定SSL证书的HTTPS端口。Port.0 Port.1对应多个Port。如果Port不存在则不会绑定
SSLId (str) - (Required) 证书ID，如果没有指定证书ID也没有申请免费证书，HTTPS接入无法正常工作
UGAId (str) - (Required) UGA实例ID

Response

create_global_ssh_instance(req: Optional[dict] = None, **kwargs) → dict[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, 65123端口。如果InstanceType=Free，取值范围缩小为[22,3389],linux系统选择22，windows系统自动选3389。
TargetIP (str) - (Required) 被SSH访问的源站IP，仅支持IPv4地址。
BandwidthPackage (int) - Ultimate版本带宽包大小,枚举值：[0,20,40]。单位MB
ChargeType (str) - 支付方式，如按月：Month、按年：Year、按时：Dynamic
CouponId (str) - 使用代金券可冲抵部分费用
ForwardRegion (str) - InstanceType等于Basic时可以在[“cn-bj2”,”cn-sh2”,”cn-gd”]中选择1个作为转发机房，其他付费版默认配置三个转发机房
InstanceType (str) - 枚举值：[“Ultimate”,”Enterprise”,”Basic”,”Primary”], 分别代表旗舰版，企业版，基础版，入门版
Quantity (int) - 购买数量按月购买至月底请传0
Remark (str) - 备注信息

Response

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

create_path_xssl(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID org-xxx格式。请参考 GetProjectList接口
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_uga_forwarder(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUGAForwarder - 创建加速实例转发器，支持HTTPS接入HTTPS回源、HTTPS接入HTTP回源、HTTP接入HTTP回源、TCP接入TCP回源、UDP接入UDP回源、支持WSS接入WSS回源、WSS接入WS回源、WS接入WS回源

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
UGAId (str) - (Required) 加速配置实例ID
HTTPHTTP (list) - HTTP接入HTTP回源转发，接入端口。禁用65123端口
HTTPHTTPRS (list) - HTTP接入HTTP回源转发，源站监听端口
HTTPSHTTP (list) - HTTPS接入HTTP回源转发，接入端口。禁用65123端口
HTTPSHTTPRS (list) - HTTPS接入HTTP回源转发，回源端口
HTTPSHTTPS (list) - HTTPS接入HTTPS回源转发，接入端口。禁用65123端口
HTTPSHTTPSRS (list) - HTTPS接入HTTPS回源转发，源站监听端口
TCP (list) - TCP接入端口，禁用65123端口
TCPRS (list) - TCP回源端口
UDP (list) - UDP接入端口，禁用65123端口
UDPRS (list) - UDP回源端口
WSSWS (list) - WebSocketS接入WebSocket回源转发，接入端口。禁用65123。
WSSWSRS (list) - WebSocketS接入WebSocket回源转发，源站监听端口。
WSSWSS (list) - WebSocketS接入WebSocketS回源转发，接入端口。禁用65123。
WSSWSSRS (list) - WebSocketS接入WebSocketS回源转发，源站监听端口。
WSWS (list) - WebSocket接入WebSocket回源转发，接入端口。禁用65123。
WSWSRS (list) - WebSocket接入WebSocket回源转发，源站监听端口

Response

create_uga_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUGAInstance - 创建全球加速配置项

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口
Name (str) - (Required) 加速配置实例名称
Domain (str) - 加速源域名，IPList和Domain二选一必填
IPList (str) - 加速源IP，多个IP用英文半角逗号(,)隔开；IPList和Domain二选一必填
TCP (list) - TCP端口号，已废弃。请使用 CreateUGAForwarder API 创建端口
UDP (list) - UDP端口号，已废弃。请使用 CreateUGAForwarder API 创建端口

Response

CName (str) - 加速域名用户可把业务域名CName到此域名上。注意：未绑定线路情况时加速域名解析不出IP。
Message (str) - 返回信息
UGAId (str) - 加速配置ID

create_upath(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUPath - 创建UPath

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口
Bandwidth (int) - (Required) 线路带宽，最小1Mbps,最大带宽由 DescribePathXLineConfig 接口获得。如需更大带宽，请联系产品团队。
LineId (str) - (Required) 选择的线路
Name (str) - (Required) UPath名字
ChargeType (str) - 计费模式，默认为Month 按月收费,可选范围[‘Month’,’Year’,’Dynamic’]
CouponId (str) - 代金券Id
PostPaid (bool) - 是否开启后付费, 默认为false
Quantity (int) - 购买周期，ChargeType为Month时，Quantity默认为0代表购买到月底，按时和按年付费该参数必须大于0

Response

UPathId (str) - 加速线路实例Id

delete_global_ssh_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteGlobalSSHInstance - 删除GlobalSSH实例

Request

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

Response

Message (str) - 提示信息

delete_path_xssl(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeletePathXSSL - 删除PathX SSL证书

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
SSLId (str) - (Required) SSL证书的ID

Response

delete_uga_forwarder(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUGAForwarder - 删除加速实例转发器按接入端口删除

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
UGAId (str) - (Required) 加速配置实例ID
HTTPHTTP (list) - HTTP接入HTTP回源，接入端口。禁用65123端口
HTTPSHTTP (list) - HTTPS接入HTTP回源，接入端口。禁用65123端口
HTTPSHTTPS (list) - HTTPS接入HTTPS回源，接入端口。禁用65123端口
TCP (list) - TCP接入端口
UDP (list) - UDP接入端口
WSSWS (list) - WebSocketS接入WebSocket回源，接入端口。禁用65123端口。
WSSWSS (list) - WebSocketS接入WebSocketS回源，接入端口。禁用65123端口
WSWS (list) - WebSocket接入WebSocket回源，接入端口。禁用65123端口

Response

delete_uga_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUGAInstance - 删除全球加速服务加速配置

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口
UGAId (str) - (Required) 加速配置实例ID

Response

Message (str) - 消息提示

delete_upath(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUPath - 删除UPath

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
UPathId (str) - (Required) 加速线路实例ID

Response

describe_global_ssh_area(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeGlobalSSHArea -

Request

ProjectId (str) - (Config)
Region (str) - (Config)

Response

AreaSet (list) - 见 GlobalSSHArea 模型定义
Message (str) -

Response Model

GlobalSSHArea - Area (str) - - AreaCode (str) - - RegionSet (list) -

describe_global_ssh_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

InstanceSet (list) - 见 GlobalSSHInfo 模型定义

Response Model

GlobalSSHInfo - AcceleratingDomain (str) - GlobalSSH分配的加速域名。 - Area (str) - 被SSH访问的IP所在地区 - BandwidthPackage (int) - globalssh Ultimate带宽包大小 - ChargeType (str) - 支付周期，如Month,Year,Dynamic等 - CreateTime (int) - 资源创建时间戳 - Expire (bool) - 是否过期 - ExpireTime (int) - 资源过期时间戳 - ForwardRegion (str) - InstanceType为Basic版本时，需要展示具体分配的转发机房 - GlobalSSHPort (int) - InstanceType等于Free时，由系统自动分配，不等于源站Port值。InstanceType不等于Free时，与源站Port值相同。 - InstanceId (str) - 实例ID，资源唯一标识 - InstanceType (str) - 枚举值：[“Enterprise”,”Basic”,”Free”,”Welfare”], 分别代表企业版，基础版本，免费版本，较早的公测免费版 - Port (int) - 源站服务器监听的SSH端口，windows系统为RDP端口 - Remark (str) - 备注信息 - TargetIP (str) - 被SSH访问的源站 IPv4地址。

describe_path_x_line_config(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribePathXLineConfig - 获取全球加速线路信息

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口

Response

LineSet (list) - 见 UGAALine 模型定义

Response Model

UGAALine - LineDetail (list) - 见 LineDetail 模型定义 - LineFrom (str) - 线路源 - LineFromName (str) - 线路源中文名称 - LineId (str) - 线路计费Id - LineTo (str) - 线路目的 - LineToName (str) - 线路目的中文名称 - MaxBandwidth (int) - 线路可售最大带宽

LineDetail - LineFrom (str) - 线路源 - LineFromName (str) - 线路源中文名称 - LineId (str) - 线路计费Id - LineTo (str) - 线路目的 - LineToName (str) - 线路目的中文名称

describe_path_xssl(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribePathXSSL - 获取SSL证书信息,支持分页，支持按证书名称证书域名模糊搜索

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
Limit (int) - 最大返回条数，默认100，最大400
Offset (int) - 偏移值默认为0
SSLId (str) - SSL证书的Id，不传分页获取证书列表
SearchValue (str) - 不为空则按证书名称、证书域名模糊搜索分页返回结果

Response

DataSet (list) - 见 PathXSSLSet 模型定义
TotalCount (int) - 符合条件的证书总数

Response Model

PathXSSLSet - CreateTime (int) - SSL证书的创建时间时间戳 - ExpireTime (int) - 证书过期时间时间戳 - SSLBindedTargetSet (list) - 见 SSLBindedTargetSet 模型定义 - SSLContent (str) - SSL证书内容 - SSLId (str) - SSL证书的Id - SSLMD5 (str) - SSL证书（用户证书、私钥、ca证书合并）内容md5值 - SSLName (str) - SSL证书的名字 - SourceType (int) - 证书来源，0：用户上传 1: 免费颁发 - SubjectName (str) - 证书域名

SSLBindedTargetSet - ResourceId (str) - SSL证书绑定到的实例ID - ResourceName (str) - SSL证书绑定到的实例名称

describe_uga_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUGAInstance - 获取全球加速服务加速配置信息，指定实例ID返回单个实例。未指定实例ID时指定分页参数则按创建时间降序返回记录

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
Limit (int) - 返回的最大条数，默认为100，最大值400
Offset (int) - 偏移量，默认为0
UGAId (str) - 加速配置实例ID，如果传了实例ID 则返回匹配实例ID的记录；如果没传则返回 ProjectId 下全部实例且符合分页要求

Response

TotalCount (int) - 符合条件的总数
UGAList (list) - 见 UGAAInfo 模型定义

Response Model

UGAAInfo - CName (str) - 加速域名，请在加速区域配置您的业务域名的CName记录值为加速域名 - Domain (str) - 源站域名 - IPList (list) - 源站IP列表，多个值由半角英文逗号相隔 - L4ForwarderSet (list) - 见 UGAL4Forwarder 模型定义 - L7ForwarderSet (list) - 见 UGAL7Forwarder 模型定义 - Location (str) - 源站所在区域，加速实例在绑定线路后会自动设置该值。console页面上通过该值过滤加速实例可以绑定的upath实例。注意：缺少该值会导致在console上无法修改线路 - OutPublicIpList (list) - 见 OutPublicIpInfo 模型定义 - TaskSet (list) - 见 UGAATask 模型定义 - UGAId (str) - 加速配置实例ID - UGAName (str) - 加速配置名称 - UPathSet (list) - 见 UPathSet 模型定义

UGAL4Forwarder - Port (int) - 接入端口 - Protocol (str) - 转发协议，枚举值[“TCP”，”UDP”，”HTTPHTTP”，”HTTPSHTTP”，”HTTPSHTTPS”]。TCP和UDP代表四层转发，其余为七层转发 - RSPort (int) - RSPort，源站监听端口

UGAL7Forwarder - Port (int) - 接入端口 - Protocol (str) - 转发协议，枚举值[“TCP”，”UDP”，”HTTPHTTP”，”HTTPSHTTP”，”HTTPSHTTPS”]。TCP和UDP代表四层转发，其余为七层转发 - RSPort (int) - RSPort，源站监听端口 - SSLId (str) - 证书ID - SSLName (str) - 证书名称

OutPublicIpInfo - Area (str) - 线路出口机房代号 - IP (str) - 线路出口EIP

UGAATask - Port (int) - 接入端口 - Protocol (str) - 转发协议，枚举值[“TCP”，”UDP”，”HTTPHTTP”，”HTTPSHTTP”，”HTTPSHTTPS”]。TCP和UDP代表四层转发，其余为七层转发

UPathSet - Bandwidth (int) - 带宽 Mbps, 1~800Mbps - LineFrom (str) - 线路起点英文代号，加速区域 - LineFromName (str) - 线路起点中文名字，加速区域 - LineId (str) - 线路ID - LineTo (str) - 线路对端英文代号，源站区域 - LineToName (str) - 线路对端中文名字，源站区域 - UPathId (str) - UPath 实例ID - UPathName (str) - UPath名字

describe_upath(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUPath - 获取加速线路信息

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
UPathId (str) - 如果不填参数返回 ProjectId 下所有的线路资源，填此参数则返回upath实例ID匹配的线路

Response

UPathSet (list) - 见 UPathInfo 模型定义

Response Model

UPathInfo - Bandwidth (int) - 带宽，单位Mbps - ChargeType (str) - 计费模式，默认为Month 按月收费,可选范围[‘Month’,’Year’,’Dynamic’] - CreateTime (int) - UPath创建的时间，10位时间戳 - ExpireTime (int) - UPath的过期时间，10位时间戳 - LineFromName (str) - 线路入口名称 - LineId (str) - 选择的线路 - LineToName (str) - 线路出口名称 - Name (str) - UPath实例名字 - OutPublicIpList (list) - 见 OutPublicIpInfo 模型定义 - PostPaid (bool) - 是否为后付费实例 - UGAList (list) - 见 PathXUGAInfo 模型定义 - UPathId (str) - UPath加速线路实例ID

OutPublicIpInfo - Area (str) - 线路出口机房代号 - IP (str) - 线路出口EIP

PathXUGAInfo - Domain (str) - 源站域名 - IPList (list) - 源站IP列表，多个值由半角英文逗号相隔 - UGAId (str) - 加速配置ID

describe_upath_template(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUPathTemplate - 查询UPath的监控模板

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
UPathId (str) - (Required) 加速线路实例ID,格式 upath-xxxx

Response

DataSet (list) - 见 AlarmRuler 模型定义

Response Model

AlarmRuler - AlarmFrequency (int) - 告警探测周期，单位秒 - AlarmStrategy (str) - 收敛策略，可选范围 [‘Exponential’,’Continuous’,’Once’]，分别对应指数递增、连续告警、单次告警 - AlarmTemplateRuleId (int) - 告警模板策略ID - Compare (str) - 比较策略，可选 [‘GE’,’LE’] 分别代表不小于和不大于 - ContactGroupId (int) - 联系组ID - MetricName (str) - 告警指标名称, 所有n的个数必须一致。目前仅允许以下四项：UpathNetworkOut:出向带宽，UpathNetworkIn:入向带宽，UpathNetworkOutUsage:出向带宽使用率，UpathNetworkInUsage:入向带宽使用率 - ResourceType (str) - 资源类型 - Threshold (int) - 告警阈值，带宽使用率的阈值范围是[50,100]的正整数，带宽告警阈值为1000000的倍数, 如大于2Mbps则告警阈值应该传 2000000 - TriggerCount (int) - 告警触发周期（次数）

get_global_ssh_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetGlobalSSHPrice - 获取GlobalSSH价格

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口
ChargeType (str) - 计费类型：Dynamic，Month，Year
InstanceType (str) - 版本类型。枚举值，Enterprise:企业版；Basic:基础版。可不填，默认为Basic。
Quantity (int) - 购买周期，如果ChargeType为Month，Quantity默认为0；其他情况必须为大于0的整数

Response

Price (float) - 价格,返回单位为元

get_global_ssh_update_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetGlobalSSHUpdatePrice - 获取GlobalSSH升级价格

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口
InstanceType (str) - (Required) 升级后的实例类型。枚举值，Enterprise:企业版；Basic:基础版。
ChargeType (str) - 计费类型：Dynamic，Month，Year。从免费版升级到付费版必须传，其他情况不需要传
InstanceId (str) - 实例ID，唯一资源标识。从免费版升级到付费版可不填，其他情况必填。
Quantity (int) - 购买周期，如果ChargeType为Month，Quantity可以不填默认为0；其他情况必须为正整数。

Response

Price (float) - 价格,返回单位为元。正数表示付费升级，负数表示降级退费。

get_path_x_metric(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetPathXMetric - 获取全球加速监控信息

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
BeginTime (int) - (Required) 查询起始时间，10位长度时间戳
EndTime (int) - (Required) 查询结束时间，10位长度时间戳
LineId (str) - (Required) 具体线路id，调用DescribePathXLineConfig接口获取线路列表
MetricName (list) - (Required) 查询监控的指标项。目前仅允许以下四项：NetworkOut:出向带宽，NetworkIn:入向带宽，NetworkOutUsage:出向带宽使用率，NetworkInUsage:入向带宽使用率
ResourceId (str) - (Required) ResourceId，如upath ID 和 uga ID
ResourceType (str) - (Required) upath:加速线路,uga:加速实例

Response

DataSet (dict) - 见 MetricPeriod 模型定义

Response Model

MetricPeriod - NetworkIn (list) - 见 MatricPoint 模型定义 - NetworkInUsage (list) - 见 MatricPoint 模型定义 - NetworkOut (list) - 见 MatricPoint 模型定义 - NetworkOutUsage (list) - 见 MatricPoint 模型定义

MatricPoint - Timestamp (int) - 时间戳 - Value (int) - 监控点数值

modify_global_ssh_port(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyGlobalSSHPort - 修改GlobalSSH端口

Request

ProjectId (str) - (Config) 项目ID，如org-xxxx。请参考 GetProjectList接口
InstanceId (str) - (Required) 实例ID,资源唯一标识。当前仅收费版GlobalSSH实例可以修改端口。
Port (int) - (Required) 源站服务器监听的SSH端口号。收费版本端口范围[1,65535]且不能为80，443，65123端口。免费版不支持修改端口。

Response

Message (str) - 提示信息

modify_global_ssh_remark(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyGlobalSSHRemark -

Request

ProjectId (str) - (Config)
InstanceId (str) - (Required)
Remark (str) -

Response

Message (str) -

modify_global_ssh_type(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyGlobalSSHType - 修改GlobalSSH实例类型，仅支持低版本升级到高版本，不支持高版本降级到低版本

Request

ProjectId (str) - (Config) 项目ID，如org-xxxx。请参考 GetProjectList接口
InstanceId (str) - (Required) 实例ID,资源唯一标识
InstanceType (str) - (Required) 取值范围[“Enterprise”,”Basic”]，分别对应企业版和基础版，表示升级后的实例类型。比如从Free版本升级为Basic版或Enterprise版，不可从收费版降级为免费版，或从企业版降级为基础版
ChargeType (str) - 支付方式，如按月、按年、按时
CouponId (str) - 可抵扣费用的券，通常不使用
Quantity (str) - 购买时间，当ChargeType为Month，Quantity为0代表购买到月底

Response

Message (str) - 提示信息

modify_upath_bandwidth(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyUPathBandwidth - 修改加速线路带宽

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Bandwidth (int) - (Required) 线路带宽，单位Mbps。最小1Mbps,最大带宽由 DescribePathXLineConfig 接口获得。如需更大带宽，请联系产品团队。
UPathId (str) - (Required) UPath 加速线路实例Id

Response

modify_upath_template(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyUPathTemplate - 修改UPath监控告警项

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
UPathId (str) - (Required) 加速线路实例ID
AlarmFrequency (list) - 告警探测周期，单位：秒
AlarmStrategy (list) - 收敛策略，可选范围 [‘Exponential’,’Continuous’,’Once’]，分别对应指数递增、连续告警、单次告警
Compare (list) - 比较策略，可选 [‘GE’,’LE’] 分别代表不小于和不大于
ContactGroupId (list) - 告警组id
MetricName (list) - 告警指标名称, 所有n的个数必须一致。目前仅允许以下四项：UpathNetworkOut:出向带宽，UpathNetworkIn:入向带宽，UpathNetworkOutUsage:出向带宽使用率，UpathNetworkInUsage:入向带宽使用率
Threshold (list) - 告警阈值，带宽使用率的阈值范围是[50,100]的正整数，带宽告警阈值为1000000的倍数, 如大于2Mbps则告警阈值应该传 2000000
TriggerCount (list) - 告警触发周期（次数）

Response

uga_bind_upath(req: Optional[dict] = None, **kwargs) → dict[source]¶

UGABindUPath - UGA绑定UPath

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
UGAId (str) - (Required) 加速配置实例ID，格式uga-xxxx
UPathId (str) - (Required) 加速线路实例ID，格式upath-xxx
CouponId (str) - 代金券

Response

uga_un_bind_upath(req: Optional[dict] = None, **kwargs) → dict[source]¶

UGAUnBindUPath - UGA与UPath解绑

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
UGAId (str) - (Required) 加速配置实例ID 格式uga-xxx
UPathId (str) - (Required) 加速线路实例ID 格式upath-xxx

Response

un_bind_path_xssl(req: Optional[dict] = None, **kwargs) → dict[source]¶

UnBindPathXSSL - 解绑PathX SSL 证书

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
Port (list) - (Required) 解绑SSL证书的HTTPS端口。Port.0 Port.1格式端口错误则解绑失败。
SSLId (str) - (Required) SSL证书ID。
UGAId (str) - (Required) UGA实例ID。

Response

update_path_x_whitelist(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdatePathXWhitelist - 更新入口白名单,仅限GlobalSSH 实例使用。其他uga-实例不生效

Request

ProjectId (str) - (Config) 项目ID,如org-xxxx。请参考 GetProjectList接口
InstanceId (str) - (Required) GlobalSSH实例ID，资源唯一标识
Whitelist (list) - 白名单规则,例如 “Whitelist.0”: “192.168.1.1/24|tcp|22”，”Whitelist.1”: “192.168.1.2|tcp|8080:8090”，第一个参数为ip或ip段，第二个参数代表协议（tcp/udp），第三个参数代表端口号或端口范围（使用 ‘:’ 隔开）；可以添加多条规则（递增Whitelist.n字段内的n值）；此接口需要列出全部规则，例如不填则为清空白名单规则，如若需要增量添加，使用InsertPathXWhitelist接口,globalssh 没有端口范围：端口设置成加速端口，协议设置成tcp:ip|tcp|加速端口

Response

StepFlow¶

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

create_sf_workflow_from_template(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: dict, transport=None, middleware=None, logger=None)[source]¶

add_member_to_project(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddMemberToProject - 添加成员到项目

Request

ProjectId (str) - (Config) 项目ID，请参考 GetProjectList接口的描述。不填写为创建时间最早的项目。
CharacterId (str) - (Required) 被加入成员归属角色ID
MemberEmail (str) - (Required) 被加入成员Email

Response

create_character(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateCharacter - 创建角色

Request

CharacterName (str) - (Required) 角色名称，不得与现有角色重名
Add (list) - 角色对产品的权限(增)
CharacterDescription (str) - 角色描述
Del (list) - 角色对产品的权限(删)
Get (list) - 角色对产品的权限(查)
Mod (list) - 角色对产品的权限(改)

Response

CharacterId (str) - 角色ID

create_project(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateProject - 创建项目

Request

ProjectName (str) - (Required) 项目名称，不得与现有项目重名

Response

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

describe_character_list(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeCharacterList - 获取角色列表

Request

Limit (int) - 角色列表的最大数量，默认为20
Offset (int) - 角色列表的偏移量，默认为0

Response

CharacterSet (list) - 见 CharacterSet 模型定义
TotalCount (int) - 角色总数

Response Model

PermissionSet - Add (list) - 有增权限的产品列表 - Del (list) - 有删权限的产品列表 - Get (list) - 有查权限的产品列表 - Mod (list) - 有改权限的产品列表

CharacterSet - CharacterDescription (str) - 角色描述 - CharacterId (str) - 角色ID - CharacterName (str) - 角色名 - Modifiable (bool) - 可修改性 - PermissionSet (list) - 见 PermissionSet 模型定义

describe_member_list(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeMemberList - 获取成员列表，限主账号使用。

Request

ProjectId (str) - (Config) 项目ID，请参考 GetProjectList接口。不填写为查询所有项目。
Limit (str) - 成员列表的最大数量，默认为200
Offset (str) - 成员列表的偏移量，默认为0

Response

MemberSet (list) - 见 MemberInfo 模型定义
TotalCount (int) - 成员总数

Response Model

ProjectInfo - CharacterId (str) - 角色ID - ProjectId (str) - 项目ID，请参考 GetProjectList接口 - ProjectName (str) - 项目名

MemberInfo - ActivateFlag (int) - 激活状态（0：未激活，1：已激活） - Created (int) - 创建时间 - DefultProjectId (str) - 默认项目 - IsAdmin (int) - 是否主账号（0：子账号，1：主账号） - IsFinance (int) - 是否有财务权限（0：无财务权限，1：有财务权限） - LastLogin (int) - 最后一次登录时间 - LastRegionId (str) - 最后访问的机房 - MemberEmail (str) - 成员邮箱 - MemberName (str) - 成员名字 - MemberPhone (str) - 成员手机 - MemberPosition (str) - 成员地址 - MemberQQ (str) - 成员QQ - PasswordPolicyDate (int) - 密码安全策略开启时间，格式：unix timestamp - ProjectSet (list) - 见 ProjectInfo 模型定义 - PublicKey (str) - 公钥 - State (str) - 状态 - TOTPStatus (int) - TOTP状态（0：未开启，1：已开启）

freeze_member(req: Optional[dict] = None, **kwargs) → dict[source]¶

FreezeMember - 冻结成员

Request

MemberEmail (str) - (Required) 需要被冻结的成员Email

Response

get_network_mask(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetNetworkMask - 查询登录与API调用的网络掩码

Request

Response

Data (dict) - 见 NetworkMask 模型定义
Message (str) - 接口信息，成功时为`success`，错误时显示具体错误信息。

Response Model

NetworkMask - APINetworkMask (str) - API调用网络掩码，默认空字符串，不限制登录IP，多个IP以英文逗号分隔。 - LoginNetworkMask (str) - 登录网络掩码，默认空字符串，不限制登录IP，多个IP以英文逗号分隔。

get_project_list(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetProjectList - 获取项目列表

Request

IsFinance (str) - 是否是财务账号（Yes：是，No：否）

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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

GetUserInfo -

Request

Response

DataSet (list) - 见 UserInfo 模型定义

Response Model

UserInfo - Admin (int) - - Administrator (str) - - AuthState (str) - - City (str) - - CompanyName (str) - - Finance (int) - - IndustryType (int) - - PhonePrefix (str) - - Province (str) - - UserAddress (str) - - UserEmail (str) - - UserId (int) - - UserName (str) - - UserPhone (str) - - UserType (int) - - UserVersion (int) -

invite_subaccount(req: Optional[dict] = None, **kwargs) → dict[source]¶

InviteSubaccount - 邀请子帐号成员

Request

IsFinance (str) - (Required) 是否有财务权限(true:是,false:否,默认为否)
UserEmail (str) - (Required) 受邀成员邮箱地址，不得重复
UserName (str) - (Required) 受邀成员姓名
UserPhone (str) - (Required) 受邀成员手机号码

Response

modify_character(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyCharacter - 修改角色

Request

CharacterId (str) - (Required) 角色ID
Add (list) - 角色权限(增)
CharacterDescription (str) - 角色描述
CharacterName (str) - 新角色名称
Del (list) - 角色权限(删)
Get (list) - 角色权限(查)
Mod (list) - 角色权限(改)

Response

modify_project(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyProject -

Request

ProjectId (str) - (Config)
ProjectName (str) - (Required)

Response

remove_member_from_project(req: Optional[dict] = None, **kwargs) → dict[source]¶

RemoveMemberFromProject - 从项目中移除成员

Request

ProjectId (str) - (Config) 项目ID，请参考 GetProjectList接口的描述。不填写为默认项目，子帐号必须填写。
MemberEmail (str) - (Required) 需要被移除成员Email

Response

set_network_mask(req: Optional[dict] = None, **kwargs) → dict[source]¶

SetNetworkMask - 设置登录与API调用的网络掩码

Request

Code (str) - (Required) 短信验证码
APINetworkMask (str) - API调用网络掩码，多个IP以英文逗号分隔。默认空字符串，不限制登录IP。
LoginNetworkMask (str) - 登录网络掩码，多个IP以英文逗号分隔。默认空字符串，不限制登录IP。

Response

Message (str) - 接口信息，成功时为`success`，错误时显示具体错误信息。

terminate_character(req: Optional[dict] = None, **kwargs) → dict[source]¶

TerminateCharacter - 删除用户角色管理列表中的指定角色

Request

CharacterId (str) - (Required) 角色ID，使用 DescribeCharacterList接口获取角色ID

Response

terminate_member(req: Optional[dict] = None, **kwargs) → dict[source]¶

TerminateMember - 删除管理员人员管理页面的指定子账号

Request

MemberEmail (str) - (Required) 用户邮箱

Response

terminate_project(req: Optional[dict] = None, **kwargs) → dict[source]¶

TerminateProject - 删除项目

Request

ProjectId (str) - (Config) 项目ID，请参考 GetProjectList接口的描述。

Response

UCDN¶

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

add_certificate(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddCertificate - 添加证书

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
CertName (str) - (Required) 证书名称
PrivateKey (str) - (Required) 用户私钥
UserCert (str) - (Required) 用户证书
CaCert (str) - Ca证书，默认为空

Response

batch_describe_new_ucdn_domain(req: Optional[dict] = None, **kwargs) → dict[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-月95计费，31-月日均峰值， 32-月第四峰值 33-日均峰值之和 34- 日95再取平均 40-未选择计费方式
DomainSet (list) - 见 DomainInfo 模型定义
LastChargeType (int) - 表示最后一次切换的计费方式，10=流量付费 20=带宽日峰值 30=按月后付费 40=未选择计费方式
MaxDomainNum (int) - 最大域名数量，默认20
TotalCount (int) - 满足条件的域名个数
Vip (str) - vip标示，yes-是 no-否

Response Model

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时间。格式：时间戳

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

CacheConf - CacheBehavior (bool) - 是否缓存，true为缓存，flase为不缓存。为flase的情况下，CacheTTL和CacheUnit强制不生效 - CacheTTL (int) - 缓存时间 - CacheUnit (str) - 缓存时间的单位。sec（秒），min（分钟），hour（小时），day（天）。上限1年。 - Description (str) - 缓存规则描述 - FollowOriginRule (bool) - 是否优先遵循源站头部缓存策略，false为不优先遵循源站，true为优先遵循源站缓存头部。默认为0 - HttpCodePattern (str) - 状态码模式，非200，206状态码，多个状态码用竖线(|)分隔，该属性仅仅在状态码缓存配置列表中返回 - PathPattern (str) - 路径模式，支持正则

batch_refresh_new_ucdn_domain_cache(req: Optional[dict] = None, **kwargs) → dict[source]¶

BatchRefreshNewUcdnDomainCache - 批量刷新缓存

Request

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

Response

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

control_ucdn_domain_cache_access(req: Optional[dict] = None, **kwargs) → dict[source]¶

ControlUcdnDomainCacheAccess - 封禁解封缓存访问

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (str) - (Required) forbid=封禁 unforbid=解封其他值非法
UrlList (list) - (Required) 待封禁的Url，一次封禁多个Url时最多一次30条，只能对表示文件的Url进行操作

Response

delete_certificate(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteCertificate - 删除证书

Request

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

Response

describe_new_ucdn_prefetch_cache_task(req: Optional[dict] = None, **kwargs) → dict[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

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

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

describe_new_ucdn_refresh_cache_task(req: Optional[dict] = None, **kwargs) → dict[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

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

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

get_certificate_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetCertificateV2 - 获取证书列表(新)

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Limit (int) - 长度，默认为全部，非负整数
Offset (int) - 偏移，默认为0，非负整数

Response

CertList (list) - 见 CertList 模型定义
TotalCount (int) - 证书数量

Response Model

CertList - BeginTime (int) - 证书开始时间 - CaCert (str) - ca证内容 - CertName (str) - 证书名 - CommonName (str) - 通用名 - DnsName (str) - dns名称 - DomainCount (int) - 已配置域名个数 - Domains (list) - 已配置的域名列表 - EndTime (int) - 证书获取时间 - UserCert (str) - 证书内容

get_new_ucdn_domain_bandwidth(req: Optional[dict] = None, **kwargs) → dict[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 (float) - 从起始时间到结束时间内的所使用的CDN总流量，单位GB

Response Model

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

get_new_ucdn_domain_hit_rate(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetNewUcdnDomainHitRate - 获取域名命中率

Request

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

Response

HitRateList (list) - 见 HitRateInfo 模型定义

Response Model

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

get_new_ucdn_domain_http_code(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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) - 时间 - Total (int) - 当前分组的总状态码数

get_new_ucdn_domain_request_num(req: Optional[dict] = None, **kwargs) → dict[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_new_ucdn_log_referer_statistics(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetNewUcdnLogRefererStatistics - 获取热点referer统计

Request

Areacode (str) - 查询带宽区域 cn代表国内 abroad代表海外；目前只支持国内
BeginTime (int) - 查询带宽的起始时间，格式：时间戳
DomainId (str) - 域名id，创建域名时生成的id
EndTime (int) - 查询统计日志的结束时间，格式：时间戳。最大时间间隔30天
Limit (int) - 返回的结果数量限制，默认1000
OrderBy (int) - 0表示按流量降序排列，1表示按照下载次数降序排列，默认为0

Response

RefererStatistics (list) - 见 RefererStatistics 模型定义

Response Model

RefererList - Percent (float) - 次数占比，单位% - Referer (str) - 客户端请求的referer - RequestTimes (int) - 次数

RefererStatistics - Date (str) - 日期 - RefererList (list) - 见 RefererList 模型定义

get_new_ucdn_log_url_statistics(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetNewUcdnLogUrlStatistics - 获取日志url统计

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
DomainId (str) - (Required) 域名Id
Areacode (str) - 查询带宽区域 cn代表国内 abroad代表海外只支持国内
BeginTime (int) - 查询带宽的起始时间，格式：时间戳。BeginTime和EndTime必须同时赋值
EndTime (int) - 查询统计日志的结束时间，格式：时间戳,最多可拉取30天
Limit (int) - 返回的结果数量限制，默认1000
OrderBy (int) - 0表示按流量降序排列，1表示按照下载次数降序排列，默认为0

Response

UrlStatisticsList (list) - 见 UrlStatistics 模型定义

Response Model

DownloadStatisticInfo - DownloadTimes (int) - 下载次数 - Percent (float) - 流量占比，单位% - Traffic (float) - 流量（单位为G） - Url (str) - 下载链接的url

UrlStatistics - Date (str) - 日期 - UrlList (list) - 见 DownloadStatisticInfo 模型定义

get_ucdn_domain_95bandwidth_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnDomain95BandwidthV2 - 获取域名九五峰值带宽数据

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
BeginTime (int) - (Required) 查询的起始日期，格式为Unix Timestamp
EndTime (int) - (Required) 查询的结束日期，格式为Unix Timestamp
Areacode (str) - 查询带宽区域 cn代表国内 abroad代表海外不填默认为全部区域
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名

Response

CdnBandwidth (float) - 查询期间的CDN的95带宽值，单位Mbps
Time (int) - 查询时间期间的95带宽时间点 Unix时间戳

get_ucdn_domain_bandwidth_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnDomainBandwidthV2 - 获取域名带宽数据(新)

Request

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

Response

BandwidthTrafficList (list) - 见 BandwidthTrafficInfo 模型定义

Response Model

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

get_ucdn_domain_config(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ChannelType (str) - 产品类型ucdn，可不填，默认为ucdn
DomainId (list) - 域名id，创建域名时生成的id。默认获取账号下的所有域名信息,n为自然数,从DomainId.0开始。
Limit (int) - 返回数据长度，默认全部，非负整数
Offset (int) - 数据偏移量，默认0，非负整数

Response

DomainList (list) - 见 DomainConfigInfo 模型定义

Response Model

DomainConfigInfo - AccessControlConf (dict) - 见 AccessControlConf 模型定义 - AdvancedConf (dict) - 见 AdvancedConf 模型定义 - AreaCode (str) - 查询带宽区域 cn代表国内 abroad代表海外 all表示全部区域 - CacheConf (dict) - 见 CacheAllConfig 模型定义 - CdnType (str) - 加速域名的业务类型，web代表网站，stream代表视频，download 代表下载 - CertNameAbroad (str) - 国外证书名称 - CertNameCn (str) - 国内证书名称 - Cname (str) - cdn域名。创建加速域名生成的cdn域名，用于设置CNAME记录 - CreateTime (int) - 域名创建的时间。格式：时间戳 - Domain (str) - 域名 - DomainId (str) - 域名Id - HttpsStatusAbroad (str) - 国外https状态 enableing-开启中 fail-开启失败 enable-启用 disable-未启用 - HttpsStatusCn (str) - 国内https状态 enableing-开启中 fail-开启失败 enable-启用 disable-未启用 - OriginConf (dict) - 见 OriginConf 模型定义 - Status (str) - 创建的加速域名的当前的状态。check代表审核中，checkSuccess代表审核通过，checkFail代表审核失败，enable代表加速中，disable代表停止加速，delete代表删除加速enableing代表正在开启加速，disableing代表正在停止加速中，deleteing代表删除中 - Tag (str) - 业务组：Default - TestUrl (str) - 测试url。用于域名创建加速时的测试

AccessControlConf - IpBlackList (list) - ip黑名单，多个ip，可表示为：IpBlackList.0=1.1.1.1，IpBlackList.1=2.2.2.2 - ReferConf (dict) - 见 ReferConf 模型定义

ReferConf - NullRefer (int) - ReferType为白名单时（删除），NullRefer为0代表不允许NULL refer访问，为1代表允许Null refer访问 - ReferList (list) - Refer防盗链规则列表，支持正则表达式 - ReferType (int) - Refer防盗链配置 0白名单，1黑名单

AdvancedConf - Http2Https (bool) - http转https回源 true是，false否 - HttpClientHeader (list) - 客户端响应http头列表 - HttpOriginHeader (list) - 源站http头列表

CacheAllConfig - CacheHost (str) - 缓存Host，不同的域名可以配置为同一个CacheHost来实现缓存共享，默认为加速域名 - CacheKeyList (list) - 见 CacheKeyInfo 模型定义 - CacheList (list) - 见 CacheConf 模型定义 - HttpCodeCacheList (list) - 见 CacheConf 模型定义

CacheKeyInfo - Ignore (bool) - 是否忽略 - PathPattern (str) - 路径模式，支持正则 - QueryString (str) - 自定义变量,以$符号开头，多个变量用加号(+)连接，$querystring表示所有变量

CacheConf - CacheBehavior (bool) - 是否缓存，true为缓存，flase为不缓存。为flase的情况下，CacheTTL和CacheUnit强制不生效 - CacheTTL (int) - 缓存时间 - CacheUnit (str) - 缓存时间的单位。sec（秒），min（分钟），hour（小时），day（天）。上限1年。 - Description (str) - 缓存规则描述 - FollowOriginRule (bool) - 是否优先遵循源站头部缓存策略，false为不优先遵循源站，true为优先遵循源站缓存头部。默认为0 - HttpCodePattern (str) - 状态码模式，非200，206状态码，多个状态码用竖线(|)分隔，该属性仅仅在状态码缓存配置列表中返回 - PathPattern (str) - 路径模式，支持正则

OriginConf - BackupOriginEnable (bool) - 1如果为false表示BackupOriginIp为空，表示没有备份源站，忽略BackupOriginIp，BackupOriginHost字段2如果为true表示BackupOriginIp.n必须至少有一个备份源站地址 - BackupOriginHost (str) - 备份回源Http请求头部Host，默认是加速域名 - BackupOriginIpList (list) - 备份源站ip即cdn服务器回源访问的ip地址。多个源站ip，可以这样表述，如：[“1.1.1.1”,”2.2.2.2”] - OriginErrorCode (str) - 主源响应的回源错误码（如：404|500），默认空字符串 - OriginErrorNum (int) - 回主源的回源失败数，默认1 - OriginFollow301 (int) - 跟随301跳转 0=不跟随 1=跟随 - OriginHost (str) - 回源Http请求头部Host，默认是加速域名 - OriginIpList (list) - 源站ip即cdn服务器回源访问的ip地址。多个源站ip，可以这样表述，如：[“1.1.1.1”,”2.2.2.2”] - OriginPort (int) - 回源端口 - OriginProtocol (str) - 源站协议http，http|https 默认http

get_ucdn_domain_hit_rate(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnDomainHitRate - 获取域名命中率

Request

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

Response

HitRateList (list) - 见 HitRateInfoV2 模型定义

Response Model

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

get_ucdn_domain_http_code_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnDomainHttpCodeV2 - 获取域名状态码信息

Request

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

Response

HttpCodeDetail (list) - 见 HttpCodeInfoV2 模型定义

Response Model

HttpCodeInfoV2 - Http1XX (dict) - 见 HttpCodeV2Detail 模型定义 - Http2XX (dict) - 见 HttpCodeV2Detail 模型定义 - Http3XX (dict) - 见 HttpCodeV2Detail 模型定义 - Http4XX (dict) - 见 HttpCodeV2Detail 模型定义 - Http5XX (dict) - 见 HttpCodeV2Detail 模型定义 - Http6XX (dict) - 见 HttpCodeV2Detail 模型定义 - Time (int) - 带宽获取的时间点。格式：时间戳

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) - 时间 - Total (int) - 当前分组的总状态码数

get_ucdn_domain_info_list(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnDomainInfoList - 获取域名基本信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
PageIndex (int) - 返回第几页，不填默认是第1页
PageSize (int) - 分页的大小，不填默认每页20个

Response

DomainInfoList (list) - 见 DomainBaseInfo 模型定义
TotalCount (int) - 账户下域名总个数

Response Model

DomainBaseInfo - Domain (str) - 域名 - DomainId (str) - 域名的资源id

get_ucdn_domain_log(req: Optional[dict] = None, **kwargs) → dict[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

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

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

get_ucdn_domain_origin_http_code(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnDomainOriginHttpCode - 获取域名源站状态码监控

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度，3表示按照1分钟粒度）
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_ucdn_domain_origin_http_code_detail(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnDomainOriginHttpCodeDetail - 获取域名源站详细状态码监控

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) - 时间 - Total (int) - 当前分组的总状态码数

get_ucdn_domain_origin_request_num(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnDomainOriginRequestNum - 获取域名回源请求数

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) - 见 RequestInfoV2 模型定义

Response Model

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

get_ucdn_domain_prefetch_enable(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

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

get_ucdn_domain_request_num_v2(req: Optional[dict] = None, **kwargs) → dict[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_request_num_v3(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnDomainRequestNumV3 - 获取域名请求数

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。默认全部域名
Protocol (str) - 协议，http、https 不传则查所有协议的带宽

Response

RequestList (list) - 见 RequestInfoV2 模型定义

Response Model

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

get_ucdn_domain_traffic(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
AccountType (str) - 指定按项目查询，还是按整个账户查询取值 top 表示按整个账户查询，取值org表示按项目查询
Areacode (str) - 查询流量区域 cn代表国内 abroad代表海外，默认全部区域
BeginTime (int) - 查询的起始日期，格式为Unix Timestamp。如果有EndTime，BeginTime必须赋值
DomainId (list) - 域名ID，创建加速域名时生成，n从自然数0开始。默认全部域名
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: Optional[dict] = None, **kwargs) → dict[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_pass_bandwidth_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (int) - (Required) 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天的粒度，3表示按照1分钟粒度）
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) - 见 BandwidthInfoDetail 模型定义

Response Model

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

get_ucdn_pro_isp_bandwidth_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnProIspBandwidthV2 - 按省份运营商获取域名带宽数据

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
BeginTime (int) - (Required) 查询的起始日期，格式为Unix Timestamp
EndTime (int) - (Required) 查询的结束日期，格式为Unix Timestamp
Type (int) - (Required) 时间粒度0 (按5分钟粒度)1 (按小时粒度)2(按天粒度)3(按分钟粒度）
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名
Isp (str) - 运营商代码（运营商拼音），一次只能查询一个运营商，不传递默认取所有运营商
Province (list) - 省份代码（省份拼音），可以传多个，不传则查询所有省份

Response

BandwidthSet (list) - 见 ProIspBandwidthSet 模型定义

Response Model

ProIspBandwidthSet - BandwidthTrafficList (list) - 见 ProIspBandwidthList 模型定义 - Province (str) - 省份代码

ProIspBandwidthList - CdnBandwidth (float) - 返回值返回指定时间区间内CDN的带宽峰值，单位Mbps - Time (int) - 带宽获取的时间点。格式：时间戳 - Traffic (float) - 对应时间粒度的流量，单位字节

get_ucdn_pro_isp_request_num_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnProIspRequestNumV2 - 按省份运营商获取域名请求数

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
BeginTime (int) - (Required) 查询的起始日期，格式为Unix Timestamp 忽略时间部分
EndTime (int) - (Required) 查询的结束日期，格式为Unix Timestamp 忽略时间部分
DomainId (list) - 域名id，创建域名时生成的id。默认全部域名
Isp (str) - 运营商代码，一次只能查询一个运营商，不传递默认取所有运营商
Province (list) - 省份代码，可以传多个，不传则查询所有省份
Type (int) - 时间粒度（0表示按照5分钟粒度，1表示按照1小时粒度，2表示按照一天粒度，3表示按照一分钟粒度）

Response

RequestNumSet (list) - 见 ProIspRequestNumSetV2 模型定义

Response Model

ProIspRequestNumSetV2 - Province (str) - 省份代码 - RequestList (list) - 见 ProIspRequestListV2 模型定义

ProIspRequestListV2 - CdnRequest (float) - 返回值返回指定时间区间内的请求数 - Time (int) - 带宽获取的时间点。格式：时间戳

get_ucdn_traffic(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnTraffic - 获取流量信息

Request

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

Response

TrafficSet (list) - 见 TrafficSet 模型定义

Response Model

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

get_ucdn_traffic_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUcdnTrafficV2 - 获取流量信息

Request

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

Response

TrafficSet (list) - 见 TrafficSet 模型定义

Response Model

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

prefetch_new_ucdn_domain_cache(req: Optional[dict] = None, **kwargs) → dict[source]¶

PrefetchNewUcdnDomainCache - 提交预取任务

Request

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

Response

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

query_ip_location(req: Optional[dict] = None, **kwargs) → dict[source]¶

QueryIpLocation - 查询IP信息

Request

Ip (list) - (Required) ip列表

Response

Data (list) - 见 IpLocationInfo 模型定义

Response Model

IpLocationInfo - Area (str) - 地区 - City (str) - 城市 - Exist (bool) - ip是否存在 - Ip (str) - 客户端请求的ip - Isp (str) - 运营商

refresh_new_ucdn_domain_cache(req: Optional[dict] = None, **kwargs) → dict[source]¶

RefreshNewUcdnDomainCache - 刷新缓存

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Type (str) - (Required) 刷新类型，file代表文件刷新，dir 代表路径刷新
UrlList (list) - (Required) 需要刷新的URL，n 从自然数0开始，刷新多个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: Optional[dict] = None, **kwargs) → dict[source]¶

SwitchUcdnChargeType - 切换账号计费方式

Request

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

Response

UDB¶

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

backup_udb_instance(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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

change_udb_param_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

ChangeUDBParamGroup - 修改配置文件

Request

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

Response

check_recover_udb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

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

check_udb_instance_to_ha_allowance(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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_mongo_db_replica_set(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateMongoDBReplicaSet - 一键创建DB副本集

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AdminPassword (str) - (Required) 管理员密码
DBTypeId (str) - (Required) DB类型id对应的字符串形式（例如：mongodb-2.6）注意：当前仅支持mongodb
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) PrimaryDB实例名称，至少6位
ParamGroupId (int) - (Required) DB实例使用的配置参数组id
Port (int) - (Required) 端口号
Zone (str) - (Required) 可用区。参见可用区列表
AdminUser (str) - 管理员帐户名，默认root
BackupCount (int) - 备份策略，每周备份数量，默认7次
BackupDuration (int) - 备份策略，备份时间间隔，单位小时计，默认24小时
BackupTime (int) - 备份策略，备份开始时间，单位小时计，默认1点
CPU (int) - cpu核数
ChargeType (str) - Year， Month， Dynamic，Trial，默认: Month
ClusterId (str) - 所属分片集群的ID
CouponId (list) - CouponId.0 代表第一个代金券id，对于传入多个代金券id，后面为 CouponId.1, CouponId.2 以此类推
InstanceType (str) - UDB数据库机型
Quantity (int) - 购买时长(N个月)，默认值1个月。如果为0，代表购买到月底。
SSDType (str) - SSD类型，可选值为”SATA”、”PCI-E”，如果UseSSD为true ，则必选
SubnetId (str) - 子网ID
UseSSD (bool) - 是否使用SSD，默认为true
VPCId (str) - VPC的ID

Response

Action (str) - 操作名称
DBIds (list) - 返回所有副本集成员的Id
RetCode (int) - 返回码

create_udb_instance(req: Optional[dict] = None, **kwargs) → dict[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 - 32T
MemoryLimit (int) - (Required) 内存限制(MB)，目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/12000M/16000M/ 24000M/32000M/48000M/ 64000M/96000M/128000M/192000M/256000M/320000M
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
EnableIpV6 (bool) - 是否创建使用ipv6 资源，默认为false，或者不填，创建ipv6为true
HAArch (str) - 高可用架构:1） haproxy（默认）: 当前仅支持mysql。2） sentinel: 基于vip和哨兵节点的架构，当前支持mysql和pg。
InstanceMode (str) - UDB实例模式类型, 可选值如下: “Normal”: 普通版UDB实例 “HA”: 高可用版UDB实例默认是”Normal”
Quantity (int) - 购买时长，默认值1
SSDType (str) - SSD类型，可选值为”SATA”、“NVMe”，如果UseSSD为true ，则必选
SubnetId (str) - 子网ID
Tag (str) - 实例所在的业务组名称
UDBCId (str) - 专区ID信息（如果这个参数存在这说明是在专区中创建DB）
UseSSD (bool) - 是否使用SSD，默认为true。目前主要可用区、海外机房、新机房只提供SSD资源，非SSD资源不再提供。
VPCId (str) - VPC的ID

Response

DBId (str) - BD实例id

create_udb_instance_by_recovery(req: Optional[dict] = None, **kwargs) → dict[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
EnableIpV6 (bool) - 是否创建使用ipv6 资源，默认为false，或者不填，创建ipv6为true
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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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，默认为 true
Zone (str) - 可用区。参见可用区列表

Response

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

create_udb_route_instance(req: Optional[dict] = None, **kwargs) → dict[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，默认为ture
Zone (str) - 可用区。参见可用区列表

Response

DBId (str) - db实例id

create_udb_slave(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUDBSlave - 创建UDB实例的slave

Request

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

Response

DBId (str) - 创建slave的DBId

delete_udb_backup(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUDBBackup -

Request

ProjectId (str) - (Config)
Region (str) - (Config)
BackupId (int) - (Required)
Zone (str) - (Required)
BackupZone (str) -

Response

delete_udb_instance(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDBBackup - 列表UDB实例备份信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - (Required) 分页显示的条目数，列表操作则指定
Offset (int) - (Required) 分页显示的起始偏移，列表操作则指定
BackupType (int) - 备份类型,取值为0或1，0表示自动，1表示手动
BeginTime (int) - 过滤条件:起始时间(Unix时间戳)
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名称 - State (str) - 备份状态 Backuping // 备份中 Success // 备份成功 Failed // 备份失败 Expired // 备份过期 - Zone (str) - 备份所在可用区

describe_udb_backup_blacklist(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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

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 - 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 - DataSet (list) - 见 UDBSlaveInstanceSet 模型定义 - DiskSpace (int) - 磁盘空间(GB), 默认根据配置机型 - DiskUsedSize (float) - DB实例磁盘已使用空间，单位GB - ExpiredTime (int) - DB实例过期时间，采用UTC计时时间戳 - IPv6Address (str) - 该实例的ipv6地址 - 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/NVMe - 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 - UserUFileData (dict) - 见 UFileDataSet 模型定义 - VPCId (str) - VPC的ID - VirtualIP (str) - DB实例虚ip - VirtualIPMac (str) - DB实例虚ip的mac地址 - Zone (str) - DB实例所在可用区

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计时时间戳 - IPv6Address (str) - 获取该实例的IPv6地址 - 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) - 可用区

UFileDataSet - Bucket (str) - bucket名称 - TokenID (str) - Ufile的令牌tokenid

describe_udb_instance_backup_state(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDBInstanceBinlogBackupState - 获取udb实例备份状态

Request

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

Response

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

describe_udb_instance_log(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDBInstanceLog - 查询某一段时间内UDB的错误日志或慢查询日志

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BeginTime (int) - (Required) 查询的日志开始的时间戳（Unix Timestamp）。对于实时查询，这个参数应该是上次轮询请求时的时间戳，后台会返回从该值到当前时间的日志内容。
DBId (str) - (Required) 实例ID
EndTime (int) - (Required) 查询日志的结束时间戳(Unix Timestamp），对于实时查询不传该值，与BeginTime的差值不超过24小时：(EndTime-BeginTime) < 24*60*60
LogType (str) - (Required) 查询日志的类型error：错误日志；slow：慢日志
Zone (str) - 可用区。参见可用区列表

Response

Log (str) - 查询到的日志内容，一段纯文本
NextTime (str) - 此次查询到的日志的下一个时间，用于下一次轮询时的BeginTime参数；如果日志查询结束则返回为空，前端结束查询

describe_udb_instance_price(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDBLogBackupURL - 获取UDB的slowlog备份地址

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

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

Response Model

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) -

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

describe_udb_splitting_info(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDBSplittingInfo - 描述读写分离功能的详细信息

Request

Region (str) - (Config) 地域。参见地域和可用区列表
MasterDBId (str) - (Required) DB实例ID
Zone (str) - (Required) 可用区。参见可用区列表

Response

DBTypeId (str) - 数据库版本
DataSet (list) - 见 UDBRWSplittingSet 模型定义
DelayThreshold (int) - 时间阈值
MasterDBId (str) - DB实例ID
Port (int) - 端口号
RWIP (str) - 读写分离IP
RWState (str) - 读写分离状态
ReadModel (str) - 读写分离策略
Zone (str) - 可用区

Response Model

UDBRWSplittingSet - DBId (str) - DB实例ID - ReadWeight (int) - 读写分离比重 - Role (str) - 主库/从库 - State (str) - DB状态 - VirtualIP (str) - DBIP

describe_udb_type(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

DataSet (list) - 见 UDBTypeSet 模型定义

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

disable_udb_rw_splitting(req: Optional[dict] = None, **kwargs) → dict[source]¶

DisableUDBRWSplitting - 关闭DB的读写分离功能

Request

Region (str) - (Config) 地域。参见地域和可用区列表
MasterDBId (str) - (Required) DB实例ID（master)
Zone (str) - (Required) 可用区。参见可用区列表

Response

edit_udb_backup_blacklist(req: Optional[dict] = None, **kwargs) → dict[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

enable_udb_rw_splitting(req: Optional[dict] = None, **kwargs) → dict[source]¶

EnableUDBRWSplitting - 开启DB的读写分离功能

Request

Region (str) - (Config) 地域。参见地域和可用区列表
MasterDBId (str) - (Required) DB实例ID（主库）
Zone (str) - (Required) 可用区。参见可用区列表
BackupZone (str) - 备份的可用区。用于创建跨可用区读写分离的一个节点，跨机房的读写分离必须有这个参数

Response

MasterDBId (str) - DB实例ID（主库）
RWIp (str) - 读写分离访问IP

extract_udb_param_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

ExtractUDBParamGroup - 获取配置文件内容

Request

Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (int) - (Required) 配置id
RegionFlag (bool) - 是否跨可用区，RegionFlag为true时表示跨可用区配置文件。如果RegionFlag=true，Zone可以不传，否则Zone必须传。
Zone (str) - 可用区。如果RegionFlag=false，必须传，反之，可不传。参见可用区列表

Response

Content (str) - 配置文件内容

fetch_udb_instance_earliest_recover_time(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

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

get_udb_client_conn_num(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUDBClientConnNum - 输入一个DBID，能够获取客户端来源IP以及对应的连接数

Request

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

Response

DataSet (list) - 见 ConnNumMap 模型定义

Response Model

ConnNumMap - Ip (str) - 客户端IP - Num (int) - 该Ip连接数

modify_udb_instance_name(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

PromoteUDBInstanceToHA - 普通db升级为高可用(只针对mysql5.5及以上版本SSD机型的实例) ，对于NVMe机型的单点升级高可用，虽然也能使用该操作再加上SwitchUDBInstanceToHA，但是更建议直接调用新的API接口（UpgradeUDBInstanceToHA）

Request

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

Response

promote_udb_slave(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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-32T
MemoryLimit (int) - (Required) 内存限制(MB)，目前支持以下几档 1000M/2000M/4000M/ 6000M/8000M/ 12000M/16000M/ 24000M/32000M/ 48000M/64000M/96000M/128000M/192000M/256000M/320000M。
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高性能大容量机型”，“NVMe_SSD”：“快杰机型”
SSDType (str) - SSD类型，可选值为”SATA”、”PCI-E”、“NVMe”，如果UseSSD为true ，则必选
StartAfterUpgrade (bool) - DB关闭状态下升降级，升降级后是否启动DB，默认为false
UDBCId (str) - 专区的ID，如果有值表示专区中的DB配置升降级
UseSSD (bool) - 是否使用SSD，默认为true
Zone (str) - 可用区。参见可用区列表

Response

restart_rw_splitting(req: Optional[dict] = None, **kwargs) → dict[source]¶

RestartRWSplitting - 读写分离中间件重启，对应docker重启，但是ip不变

Request

Region (str) - (Config) 地域。参见地域和可用区列表
MasterDBId (str) - (Required) 待关闭读写分离中间键ProxyId
Zone (str) - (Required) 可用区。参见可用区列表

Response

restart_udb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

RestartUDBInstance - 重启UDB实例

Request

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

Response

set_udb_rw_splitting(req: Optional[dict] = None, **kwargs) → dict[source]¶

SetUDBRWSplitting - 设置读写分离的模式

Request

Region (str) - (Config) 地域。参见地域和可用区列表
DBIds (list) - (Required) DBIds.0 代表UDB主节点， DBIds.1 到DBIds.n 代表1到N个从节点
MasterDBId (str) - (Required) DB实例ID（master)
ReadModel (str) - (Required) 读写分离策略
Zone (str) - (Required) 可用区。参见可用区列表
DelayThreshold (int) - 时间阙值
ReadPercents (list) - udb主从节点的只读比例。ReadPercents.0代表主节点的只读比例，ReadPercents.1代表从节点1的读写比例，以此类推

Response

start_udb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

StartUDBInstance - 启动UDB实例

Request

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

Response

stop_udb_instance(req: Optional[dict] = None, **kwargs) → dict[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_ha_to_sentinel(req: Optional[dict] = None, **kwargs) → dict[source]¶

SwitchUDBHAToSentinel - UDB高可用实例从HAProxy版本升级为Sentinel版本（不带HAProxy）升级耗时5-10秒

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DBId (str) - (Required) UDB的实例ID
Zone (str) - (Required) 可用区。参见可用区列表
ForceSwitch (bool) - 是否跳过预检查强制升级。

Response

switch_udb_instance_to_ha(req: Optional[dict] = None, **kwargs) → dict[source]¶

SwitchUDBInstanceToHA - 普通UDB切换为高可用(只针对mysql5.5及以上版本SSD机型的实例) ，原db状态为WaitForSwitch时，调用该api；对于NVMe机型的单点升级高可用，虽然也能使用PromoteUDBInstanceToHA再加上该操作，但是更建议直接调用新的API接口（UpgradeUDBInstanceToHA）

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: Optional[dict] = None, **kwargs) → dict[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 表示使用快照/物理备份，不填或者其它任何值为默认的逻辑备份。需要同时设置BackupDate字段。（注意现在只有SSD 版本的 MySQL实例支持物理备份）
BackupTime (int) - 备份的整点时间，范围[0,23]
ForceDump (bool) - 当导出某些数据遇到问题后，是否强制导出其他剩余数据默认是false需要同时设置BackupDate字段
Zone (str) - 可用区。参见可用区列表

Response

update_udb_instance_slave_backup_switch(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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

upgrade_udb_instance_to_ha(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpgradeUDBInstanceToHA - 快杰普通db升级为高可用(只针对mysql5.5及以上版本Nvme机型的实例)

Request

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

Response

upload_udb_param_group(req: Optional[dict] = None, **kwargs) → dict[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) 可用区。参见可用区列表
RegionFlag (bool) - 该配置文件是否是地域级别配置文件，默认是false

Response

GroupId (int) - 配置参数组id

UDPN¶

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

allocate_udpn(req: Optional[dict] = None, **kwargs) → dict[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-ca，华盛顿：us-ws，东京：jpn-tky
Peer2 (str) - (Required) 专线可用区2，支持地域：北京二：cn-bj2, 上海二：cn-sh2, 广东：cn-gd, 亚太： hk, 上海一：cn-sh1, 法兰克福：ge-fra, 新加坡：sg, 洛杉矶：us-ca，华盛顿：us-ws，东京：jpn-tky
ChargeType (str) - 计费类型，枚举值为： Year，按年付费； Month，按月付费； Dynamic，按需付费
CouponId (str) - 代金劵
PayMode (str) - 计费模式. 枚举值：”Traffic”, 流量计费模式; 否则带宽计费模式；
Quantity (int) - 计费时长，默认 1

Response

Action (str) - 操作名称
RetCode (int) - 返回码
UDPNId (str) - 资源名称

describe_udpn(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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) - 计费类型
PayMode (str) - PayMode，枚举值，Bandwidth：带宽；Traffic：流量默认不填写：带宽
Quantity (int) - 购买时长

Response

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

get_udpn_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: dict, transport=None, middleware=None, logger=None)[source]¶

attach_udisk(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDiskId (str) - (Required) 需要挂载的UDisk实例ID.
HostId (str) - Host实例ID
MultiAttach (str) - 是否允许多点挂载（Yes: 允许多点挂载， No: 不允许多点挂载，不填默认Yes ）
UHostId (str) - UHost实例ID。【UHostId和HostId必须选填一个，本字段即将废弃，建议使用HostId】
Zone (str) - 可用区。参见可用区列表

Response

DeviceName (str) - 挂载的设备名称
HostId (str) - 挂载的Host实例ID
UDiskId (str) - 挂载的UDisk实例ID
UHostId (str) - 挂载的UHost实例ID。【即将废弃，建议使用HostId】

clone_udisk(req: Optional[dict] = None, **kwargs) → dict[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，Trial 默认: Month
Comment (str) - Disk注释
CouponId (str) - 使用的代金券id
HostId (str) - Host实例ID。克隆出的云盘可直接挂载到该主机上。
Quantity (int) - 购买时长默认: 1
RdmaClusterId (str) - 【已废弃】RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
SnapshotService (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
Tag (str) - 业务组默认：Default
UDataArkMode (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No

Response

UDiskId (list) - 创建UDisk Id

clone_udisk_snapshot(req: Optional[dict] = None, **kwargs) → dict[source]¶

CloneUDiskSnapshot - 从快照创建UDisk克隆

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称
SourceId (str) - (Required) 克隆父Snapshot的Id
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic，Postpay 默认: Dynamic
Comment (str) - Disk注释
CouponId (str) - 使用的代金券id
HostId (str) - Host实例ID。克隆出的云盘可直接挂载到该主机上。
Quantity (int) - 购买时长默认: 1
RdmaClusterId (str) - 【已废弃】RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
Size (int) - 购买UDisk大小,单位:GB,范围[1~8000]。(UDisk大小设定对本地盘快照有效，对云盘快照无效)
SnapshotService (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
Tag (str) - 业务组默认：Default
UDataArkMode (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No

Response

UDiskId (list) - 创建UDisk Id

clone_udisk_udataark(req: Optional[dict] = None, **kwargs) → dict[source]¶

CloneUDiskUDataArk - 从数据方舟的备份创建UDisk

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称
SnapshotTime (int) - (Required) 指定从方舟克隆的备份时间点
UDiskId (str) - (Required) 需要克隆的源盘id
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic，Postpay 默认: Dynamic
Comment (str) - Disk注释
CouponId (str) - 使用的代金券id
HostId (str) - Host实例ID。克隆出的云盘可直接挂载到该主机上。
Quantity (int) - 购买时长默认: 1
RdmaClusterId (str) - 【已废弃】RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
Size (int) - 购买UDisk大小,单位:GB,范围[1~8000]。(UDisk大小设定对本地盘备份有效，对云盘备份无效)
SnapshotService (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
Tag (str) - 业务组默认：Default
UDataArkMode (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No

Response

UDiskId (list) - 创建UDisk Id

create_attach_udisk(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateAttachUDisk - 创建并挂载UDisk磁盘

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称
Size (int) - (Required) 购买UDisk大小,单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；RSSD数据盘：范围[1~32000]；高效数据盘：范围[1~32000]。
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic, Postpay, Trial 。 Size小于等于2000时，默认为Dynamic；Size大于2000时，默认为Month。
CmkId (str) - 加密需要的cmk id，UKmsMode为Yes时，必填
CouponId (str) - 使用的代金券id
DiskType (str) - UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），RSSDDataDisk（RSSD数据盘），EfficiencyDataDisk（高效数据盘），默认值（DataDisk）
HostId (str) - Host实例ID。当创建云盘类型为RSSDDataDisk时，根据传入的HostId，创建与虚机在同一PodId下的云盘。
MultiAttach (str) - 是否允许多点挂载（Yes: 允许多点挂载， No: 不允许多点挂载，不填默认Yes ）
Quantity (int) - 购买时长默认: 1
SnapshotService (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
Tag (str) - 业务组默认：Default
UDataArkMode (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
UHostId (str) - UHost实例ID。当创建云盘类型为RSSDDataDisk时，根据传入的UHostId，创建与虚机在同一PodId下的云盘。【UHostId和HostId必须选填一个，本字段即将废弃，建议使用HostId】
UKmsMode (str) - 是否加密。Yes：加密，No：不加密，默认值（No）

Response

DeviceName (str) - 挂载设备名称
HostId (str) - 挂载的Host实例ID
UDiskId (str) - 挂载的UDisk实例ID
UHostId (str) - 挂载的UHost实例ID。【即将废弃，建议使用HostId】

create_udisk(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUDisk - 创建UDisk磁盘

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 实例名称
Size (int) - (Required) 购买UDisk大小,单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；RSSD数据盘：范围[1~32000]；高效数据盘：范围[1~32000]。
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数据盘），EfficiencyDataDisk（高效数据盘），默认值（DataDisk）
Quantity (int) - 购买时长默认: 1
RdmaClusterId (str) - RDMA集群id。DiskType为RSSDDataDisk可填，指定云盘创建到对应的RDMA集群。
SnapshotService (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
Tag (str) - 业务组默认：Default
UDataArkMode (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
UKmsMode (str) - 是否加密。Yes：加密，No：不加密，默认值（No）

Response

UDiskId (list) - UDisk实例Id

create_udisk_snapshot(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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_recycle_udisk(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeRecycleUDisk - 拉取回收站中云硬盘列表

Request

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

Response

DataSet (list) - 见 RecycleUDiskSet 模型定义
TotalCount (int) - 磁盘数量

Response Model

RecycleUDiskSet - CountdownTime (int) - 销毁倒计时 - CreateTime (int) - 创建时间 - ExpiredTime (int) - 过期时间 - Name (str) - 磁盘名称 - Size (int) - 磁盘容量 - Tag (str) - 业务组 - UDiskId (str) - 磁盘id - Zone (str) - 可用区

describe_udisk(req: Optional[dict] = None, **kwargs) → dict[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”；RSSD系统盘：DiskType:”CLOUD_RSSD”,IsBoot:”True”；高效数据盘：DiskType:”CLOUD_EFFICIENCY”,IsBoot:”False”；高效系统盘：DiskType:”CLOUD_EFFICIENCY”,IsBoot:”True”；为空拉取所有。ProtocolVersion字段为0或没有该字段时，可设为以下几个值:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk；RSSD系统盘：RSSDSystemDisk：高效数据盘：EfficiencyDataDisk；高效系统盘：EfficiencySystemDisk；为空拉取所有。
HostId (str) - 根据传入的HostId，返回与该主机关联的云盘信息。
HostIdForAttachment (str) - 根据传入的HostIdForAttachment，筛选出能被挂载在该主机上的云盘。目前主要针对RSSD云盘。
HostProduct (str) - 宿主产品类型，可筛选挂载在该类型宿主上的云盘。可选值：uhost, uphost。为空拉取所有。（当HostIdForAttachment字段不为空时，该字段可以不填，若HostIdForAttachment与该字段宿主类型冲突，则以HostIdForAttachment字段为准。）
IgnoreBackupMode (str) - 是否忽略快照服务信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心快照服务信息，建议选填“Yes”，可降低请求延时）
IgnoreUBillInfo (str) - 是否忽略计费信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心账单信息，建议选填“Yes”，可降低请求延时）
IsBoot (str) - ProtocolVersion字段为1且DiskType不为空时，必须设置，设置规则请参照DiskType；ProtocolVersion字段为1且DiskType为空时，该字段无效。ProtocolVersion字段为0或没有该字段时，该字段无效。
Limit (int) - 返回数据长度, 默认为20
Offset (int) - 数据偏移量, 默认为0
ProtocolVersion (int) - 请求协议版本，建议升级为1，为1时DiskType与UHost磁盘类型定义一致；默认为0
UDiskBasicInfo (str) - 是否只返回云盘基础信息（只包含云盘及关联主机的资源信息）。Yes：是，No：否，默认值（No）。（如仅需要基础信息，建议选填“Yes”，可降低请求延时）
UDiskId (str) - UDisk Id(留空返回全部)
UHostIdForAttachment (str) - 根据传入的UHostIdForAttachment，筛选出能被挂载在该主机上的云盘【本字段即将废弃，建议使用HostIdForAttachment】
Zone (str) - 可用区。参见可用区列表

Response

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

Response Model

UDiskDataSet - ArkSwitchEnable (int) - 是否支持开启方舟，1支持，0不支持 - BackupMode (str) - 该盘的备份方式。快照服务：”SnapshotService”；数据方舟：”UDataArk”；无备份方式：”” - 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”；RSSD系统盘：DiskType:”CLOUD_RSSD”,IsBoot:”True”；高效数据盘：DiskType:”CLOUD_EFFICIENCY”,IsBoot:”False”；高效系统盘：DiskType:”CLOUD_EFFICIENCY”,IsBoot:”True”。请求中的ProtocolVersion字段为0或没有该字段时，云硬盘类型参照如下:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk；RSSD系统盘：RSSDSystemDisk；高效数据盘：EfficiencyDataDisk；高效系统盘：EfficiencySystemDisk。 - ExpiredTime (int) - 过期时间 - HostIP (str) - 挂载的Host的IP - HostId (str) - 挂载的Host的Id - HostName (str) - 挂载的Host的Name - IsBoot (str) - 是否是系统盘，是：”True”, 否：”False” - IsExpire (str) - 资源是否过期，过期:”Yes”, 未过期:”No” - Name (str) - 实例名称 - RdmaClusterId (str) - RDMA集群id，仅RSSD返回该值；其他类型云盘返回””。当云盘的此值与快杰云主机的RdmaClusterId相同时，RSSD可以挂载到这台云主机。 - 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。【即将废弃，建议使用HostIP】 - UHostId (str) - 挂载的UHost的Id。【即将废弃，建议使用HostId】 - UHostName (str) - 挂载的UHost的Name。【即将废弃，建议使用HostName】 - UKmsMode (str) - 是否是加密盘，是:”Yes”, 否:”No” - Version (str) - 是否支持数据方舟，支持:”2.0”, 不支持:”1.0” - Zone (str) - 可用区

describe_udisk_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDiskPrice - 获取UDisk实例价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 购买UDisk大小,单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；普通系统盘：范围[1~8000]；SSD系统盘：范围[1~4000]；RSSD数据盘：范围[1~32000]；RSSD系统盘：范围[1~4000]；高效数据盘：范围[1~32000]；高效系统盘：范围[1~500]。
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic，Postpay，Trial 默认: Month
DiskType (str) - UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），RSSDDataDisk(RSSD数据盘)，EfficiencyDataDisk（高效数据盘），SystemDisk（普通系统盘），SSDSystemDisk（SSD系统盘），RSSDSystemDisk(RSSD系统盘)，EfficiencySystemDisk（高效系统盘），默认值（DataDisk）
IsTotalPrice (str) - 是否将快照服务(数据方舟)，云硬盘放入一张订单, 是：”Yes”,否：”No”，默认是”No”
MachineType (str) - 云主机机型（V2.0），枚举值[“N”, “C”, “G”, “O”, “OM”]。参考云主机机型说明。
Quantity (int) - 购买UDisk的时长，默认值为1
SnapshotService (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
UDataArkMode (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No

Response

DataSet (list) - 见 UDiskPriceDataSet 模型定义

Response Model

UDiskPriceDataSet - ChargeName (str) - “UDataArk”,”SnapshotService”,”UDisk”,”Total” - ChargeType (str) - Year， Month， Dynamic，Trial - ListPrice (int) - 原价(对应计费OriginalPrice) - OriginalPrice (int) - 用户折后价(对应计费CustomPrice) - Price (int) - 实际价格 (单位: 分)

describe_udisk_snapshot(req: Optional[dict] = None, **kwargs) → dict[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：普通系统盘；2：SSD数据盘；3：SSD系统盘；4：RSSD数据盘；5：RSSD系统盘。 - 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) - 快照版本 - Zone (str) - 可用区

describe_udisk_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDiskUpgradePrice - 获取UDisk升级价格信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 购买UDisk大小,单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；普通系统盘：范围[1~8000]；SSD系统盘：范围[1~4000]；RSSD数据盘：范围[1~32000]；RSSD系统盘：范围[1~4000]；高效数据盘：范围[1~32000]；高效系统盘：范围[1~500]。
SourceId (str) - (Required) 升级目标UDisk ID
Zone (str) - (Required) 可用区。参见可用区列表
DiskType (str) - 【已废弃】UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），RSSDDataDisk(RSSD数据盘)，EfficiencyDataDisk（高效数据盘），SystemDisk（普通系统盘），SSDSystemDisk（SSD系统盘），RSSDSystemDisk(RSSD系统盘)，EfficiencySystemDisk（高效系统盘），默认值（DataDisk）
MachineType (str) - 【已废弃】云主机机型（V2.0），枚举值[“N”, “C”, “G”, “O”, “OM”]。参考云主机机型说明。
SnapshotService (str) - 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No。仅支持查询开启快照服务的价格。
UDataArkMode (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No

Response

OriginalPrice (int) - 用户折后价 (对应计费CustomPrice)
Price (int) - 价格

detach_udisk(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDiskId (str) - (Required) 需要卸载的UDisk实例ID
HostId (str) - Host实例ID
UHostId (str) - UHost实例ID。【UHostId和HostId必须选填一个，本字段即将废弃，建议使用HostId】
Zone (str) - 可用区。参见可用区列表

Response

HostId (str) - 卸载的Host实例ID
UDiskId (str) - 卸载的UDisk实例ID
UHostId (str) - 卸载的UHost实例ID。【即将废弃，建议使用HostId】

recover_udisk(req: Optional[dict] = None, **kwargs) → dict[source]¶

RecoverUDisk - 从回收站中恢复云硬盘

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDiskId (str) - (Required) 云硬盘资源ID
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic 默认: Dynamic
Quantity (int) - 购买时长默认: 1

Response

rename_udisk(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

ResizeUDisk - 调整UDisk容量

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Size (int) - (Required) 调整后大小, 单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；RSSD数据盘：范围[1~32000]。
UDiskId (str) - (Required) UDisk Id
Zone (str) - (Required) 可用区。参见可用区列表
CouponId (str) - 使用的代金券id
MachineType (str) - 云主机机型（V2.0），枚举值[“N”, “C”, “G”, “O”, “OM”]。参考云主机机型说明。

Response

restore_udisk(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UDiskId (str) - (Required) 需要设置数据方舟的UDisk的Id
Zone (str) - (Required) 可用区。参见可用区列表
CouponId (str) - 使用的代金券id
UDataArkMode (str) - 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No

Response

UHost¶

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

copy_custom_image(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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_isolation_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateIsolationGroup - 创建硬件隔离组，组内机器严格隔离在不同宿主机上。

Request

ProjectId (str) - (Config) 项目id
Region (str) - (Config) 地域。参见地域和可用区列表
GroupName (str) - (Required) 硬件隔离组名称。请遵照字段规范设定隔离组名称。
Remark (str) - 备注。请遵照字段规范设定隔离组备注。

Response

GroupId (str) - 硬件隔离组id

create_uhost_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUHostInstance - 创建UHost实例。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ImageId (str) - (Required) 镜像ID。请通过 DescribeImage 获取
LoginMode (str) - (Required) 主机登陆模式。密码（默认选项）: Password，密钥：KeyPair。
Zone (str) - (Required) 可用区。参见可用区列表
AlarmTemplateId (int) - 告警模板id，如果传了告警模板id，且告警模板id正确，则绑定告警模板。绑定告警模板失败只会在后台有日志，不会影响创建主机流程，也不会在前端报错。
AutoDataDiskInit (str) - 数据盘是否需要自动分区挂载。当镜像支持“Cloud-init”Feature时可填写此字段。取值 >“On” 自动挂载（默认值）> “Off” 不自动挂载。
CPU (int) - 虚拟CPU核数。可选参数：1-64（具体机型与CPU的对应关系参照控制台）。默认值: 4。
ChargeType (str) - 计费模式。枚举值为： > Year，按年付费； > Month，按月付费；> Dynamic，按小时预付费 > Postpay，按小时后付费（支持关机不收费，目前仅部分可用区支持，请联系您的客户经理） Preemptive计费为抢占式实例默认为月付
CouponId (str) - 主机代金券ID。请通过DescribeCoupon接口查询，或登录用户中心查看
Disks (list) - 见 CreateUHostInstanceParamDisks 模型定义
GPU (int) - GPU卡核心数。仅GPU机型支持此字段（可选范围与MachineType+GpuType相关）
GpuType (str) - GPU类型，枚举值[“K80”, “P40”, “V100”, “T4”, “T4S”,”2080Ti”,”2080Ti-4C”,”1080Ti”]，MachineType为G时必填
HotplugFeature (bool) - 热升级特性。True为开启，False为未开启，默认False。
IsolationGroup (str) - 硬件隔离组id。可通过DescribeIsolationGroup获取。
KeyPairId (str) - KeypairId 密钥对ID，LoginMode为KeyPair时此项必须
MachineType (str) - 云主机机型（V2.0），在本字段和字段UHostType中，仅需要其中1个字段即可。枚举值[“N”, “C”, “G”, “O”, “OS”, “OPRO”, “OMAX”, “O.BM”]。参考云主机机型说明。
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”；”Intel/CascadelakeR”; “Amd/Epyc2”,”Amd/Auto”],默认值是”Intel/Auto”。
Name (str) - UHost实例名称。默认：UHost。请遵照字段规范设定实例名称。
NetCapability (str) - 网络增强特性。枚举值：Normal（默认），不开启; Super，开启网络增强1.0； Ultra，开启网络增强2.0（仅支持部分可用区，请参考控制台）
NetworkInterface (list) - 见 CreateUHostInstanceParamNetworkInterface 模型定义
Password (str) - UHost密码。请遵照字段规范设定密码。密码需使用base64进行编码，举例如下：# echo -n Password1 | base64UGFzc3dvcmQx。
PrivateIp (list) - 【数组】创建云主机时指定内网IP。若不传值，则随机分配当前子网下的IP。调用方式举例：PrivateIp.0=x.x.x.x。当前只支持一个内网IP。
Quantity (int) - 购买时长。默认:值 1。按小时购买（Dynamic/Postpay）时无需此参数。月付时，此参数传0，代表购买至月末。
SecurityGroupId (str) - 防火墙ID，默认：Web推荐防火墙。如何查询SecurityGroupId请参见 DescribeFirewall 。
SubnetId (str) - 子网 ID。默认为当前地域的默认子网。
Tag (str) - 业务组。默认：Default（Default即为未分组）。请遵照字段规范设定业务组。
UHostType (str) - 【建议后续不再使用】云主机机型（V1.0），在本字段和字段MachineType中，仅需要其中1个字段即可。参考云主机机型说明。
UserData (str) - 用户自定义数据。当镜像支持Cloud-init Feature时可填写此字段。注意：1、总数据量大小不超过 16K；2、使用base64编码
VPCId (str) - VPC ID。默认为当前地域的默认VPC。

Response

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

Request Model

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

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

CreateUHostInstanceParamNetworkInterface - CreateCernetIp (bool) - 申请并绑定一个教育网EIP。True为申请并绑定，False为不会申请绑定，默认False。当前只支持具有HPC特性的机型。 - EIP (dict) - 见 CreateUHostInstanceParamNetworkInterfaceEIP 模型定义

CreateUHostInstanceParamVirtualGpuGPUVirtualGpu

CreateUHostInstanceParamVirtualGpu

CreateUHostInstanceParamVolumes

create_uhost_key_pair(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUHostKeyPair - 创建主机密钥对信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
KeyPairName (str) - (Required) 密钥对名称。由字母，数字，符号组成，长度为1-63位。
Zone (str) - 可用区。参见可用区列表

Response

KeyPair (dict) - 见 KeyPair 模型定义

Response Model

KeyPair - CreateTime (int) - 密钥对的创建时间，格式为Unix Timestamp。 - KeyPairFingerPrint (str) - 密钥对指纹。md5(ProjectId|KeyPairId|PublicKey) - KeyPairId (str) - 密钥对ID。 - KeyPairName (str) - 密钥对名称。长度为1~63个英文或中文字符。 - PrivateKeyBody (str) - 密钥对的私钥内容。只有创建接口才会返回。 - ProjectId (str) - 项目ID。

delete_isolation_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteIsolationGroup - 删除硬件隔离组。

Request

ProjectId (str) - (Config) 项目id
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 硬件隔离组id

Response

GroupId (str) - 硬件隔离组id

delete_uhost_key_pairs(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUHostKeyPairs - 删除一对或者多对密钥对。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
KeyPairIds (list) - (Required) 密钥对ID，最多支持 100 对。
Zone (str) - 可用区。参见可用区列表

Response

describe_image(req: Optional[dict] = None, **kwargs) → dict[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

Action (str) - 操作名称
ImageSet (list) - 见 UHostImageSet 模型定义
RetCode (int) - 返回码
TotalCount (int) - 满足条件的镜像总数

Response Model

UHostImageSet - CreateTime (int) - 创建时间，格式为Unix时间戳 - Features (list) - 特殊状态标识，目前包含NetEnhnced（网络增强1.0）, NetEnhanced_Ultra]（网络增强2.0）, HotPlug(热升级), CloudInit, IPv6 - 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) - 操作系统类型：Linux，Windows - State (str) - 镜像状态，可用：Available，制作中：Making，不可用：Unavailable - Vendor (str) - 供应商（仅行业镜像将返回这个值） - Zone (str) - 可用区，参见可用区列表

describe_isolation_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

IsolationGroupSet (list) - 见 IsolationGroup 模型定义
TotalCount (int) - 硬件隔离组总数

Response Model

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

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

describe_uhost_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

TotalCount (int) - UHostInstance总数
UHostSet (list) - 见 UHostInstanceSet 模型定义

Response Model

UHostInstanceSet - AutoRenew (str) - 是否自动续费，自动续费：“Yes”，不自动续费：“No” - BasicImageId (str) - 基础镜像ID（指当前自定义镜像的来源镜像） - BasicImageName (str) - 基础镜像名称（指当前自定义镜像的来源镜像） - BootDiskState (str) - 系统盘状态 Normal表示初始化完成；Initializing表示在初始化。仍在初始化的系统盘无法制作镜像。 - CPU (int) - 虚拟CPU核数，单位: 个 - ChargeType (str) - 计费模式，枚举值为： Year，按年付费； Month，按月付费； Dynamic，按需付费（需开启权限）；Preemptive 为抢占式实例； - CloudInitFeature (bool) - true，支持cloutinit方式初始化；false,不支持 - CpuPlatform (str) - 云主机CPU平台。参考云主机机型说明。 - CreateTime (int) - 创建时间，格式为Unix时间戳 - DiskSet (list) - 见 UHostDiskSet 模型定义 - ExpireTime (int) - 到期时间，格式为Unix时间戳 - GPU (int) - GPU个数 - HostType (str) - 【建议不再使用】主机系列：N2，表示系列2；N1，表示系列1 - HotplugFeature (bool) - true: 开启热升级； false，未开启热升级 - HpcFeature (bool) - true: 开启 hpc 系列功能；false: 未开启 - IPSet (list) - 见 UHostIPSet 模型定义 - IPv6Feature (bool) - true:有ipv6特性；false，没有ipv6特性 - ImageId (str) - 【建议不再使用】主机的系统盘ID。 - IsolationGroup (str) - 隔离组id，不在隔离组则返回”” - KeyPair (dict) - 见 UHostKeyPair 模型定义 - 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” - RdmaClusterId (str) - RDMA集群id，仅快杰云主机返回该值；其他类型云主机返回””。当云主机的此值与RSSD云盘的RdmaClusterId相同时，RSSD可以挂载到这台云主机。 - Remark (str) - 备注 - RestrictMode (str) - 仅抢占式实例返回，LowSpeed为低速模式，PowerOff为关机模式 - 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) - 可用区。参见可用区列表

UHostDiskSet - BackupType (str) - 备份方案。若开通了数据方舟，则为DATAARK - DiskId (str) - 磁盘ID - DiskType (str) - 磁盘类型。请参考磁盘类型。 - Drive (str) - 磁盘盘符 - Encrypted (str) - “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) - 内网 Private 类型下，表示是否为默认网卡。true: 是默认网卡；其他值：不是。 - IP (str) - IP地址 - IPId (str) - 外网IP资源ID 。(内网IP无对应的资源ID) - IPMode (str) - IPv4/IPv6； - Mac (str) - 内网 Private 类型下，当前网卡的Mac。 - NetworkInterfaceId (str) - 弹性网卡为默认网卡时，返回对应的 ID 值 - SubnetId (str) - IP地址对应的子网 ID。（北京一不支持，字段返回为空） - Type (str) - 国际: Internation，BGP: Bgp，内网: Private - VPCId (str) - IP地址对应的VPC ID。（北京一不支持，字段返回为空） - Weight (int) - 当前EIP的权重。权重最大的为当前的出口IP。

UHostKeyPair - KeyPairId (str) - 密钥对ID - KeyPairState (str) - 主机密钥对状态，Normal 正常，Deleted 删除

describe_uhost_instance_snapshot(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUHostInstanceSnapshot -

Request

ProjectId (str) - (Config)
Region (str) - (Config)
UHostId (str) - (Required)
Zone (str) -

Response

SnapshotSet (list) - 见 UHostSnapshotSet 模型定义
UhostId (str) -

Response Model

UHostSnapshotSet - SnapshotName (str) - - SnapshotState (str) - - SnapshotTime (str) -

describe_uhost_key_pairs(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUHostKeyPairs - 查询一个或多个密钥对。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
KeyPairFingerPrint (str) - 密钥对的指纹。
KeyPairName (str) - 密钥对名称。
Limit (int) - 返回数据长度，默认为20，最大100
Offset (int) - 列表起始位置偏移量，默认为0
Zone (str) - 可用区。参见可用区列表

Response

KeyPairs (list) - 见 KeyPairDesc 模型定义
TotalCount (int) - 密钥对总数

Response Model

KeyPairDesc - CreateTime (int) - 密钥对的创建时间，格式为Unix Timestamp。 - KeyPairFingerPrint (str) - 密钥对指纹。md5(ProjectId|KeyPairId|PublicKey) - KeyPairId (str) - 密钥对ID。 - KeyPairName (str) - 密钥对名称。长度为1~63个英文或中文字符。 - ProjectId (str) - 项目ID。

describe_uhost_tags(req: Optional[dict] = None, **kwargs) → dict[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_attached_disk_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetAttachedDiskUpgradePrice - 获取挂载磁盘的升级价格

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 。
BackupMode (str) - 磁盘备份方案。枚举值：> NONE，无备份 > DATAARK，数据方舟 > SNAPSHOT(SNAPSHOT模式目前仅在上海C支持)，快照当前磁盘支持的备份模式参考磁盘类型。默认值为当前的备份模式。
Zone (str) - 可用区。参见可用区列表

Response

Price (float) - 升级差价。精度为小数点后2位。

get_uhost_instance_price(req: Optional[dict] = None, **kwargs) → dict[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]
Memory (int) - (Required) 内存大小。单位：MB。范围：[1024, 262144]，取值为1024的倍数（可选范围参照好控制台）。默认值：8192
ChargeType (str) - 计费模式。枚举值为： > Year，按年付费； > Month，按月付费；> Dynamic，按小时付费 // >Preemptive 抢占式实例如果不传某个枚举值，默认返回年付、月付、时付的价格组合集。
CpuPlatform (str) - 取值”Intel” “Amd”，默认值“Intel”
Disks (list) - 见 GetUHostInstancePriceParamDisks 模型定义
GPU (int) - GPU卡核心数。仅GPU机型支持此字段。
GpuType (str) - GPU类型，枚举值[“K80”, “P40”, “V100”, “T4”,”T4S”,”2080Ti”,”2080Ti-4C”,”1080Ti”]
ImageId (str) - 镜像Id，可通过 DescribeImage 获取镜像ID，如果镜像ID不传，系统盘大小必传
MachineType (str) - 云主机机型（V2版本概念）。枚举值[“N”, “C”, “G”, “O”, “OS”, “OPRO”, “OMAX”, “O.BM”]。参考云主机机型说明。
NetCapability (str) - 网络增强。枚举值：Normal，不开启; Super，开启网络增强1.0。默认值为Normal。
Quantity (int) - 购买时长。默认: 1。按小时购买(Dynamic)时无需此参数。月付时，此参数传0，代表了购买至月末。
UHostType (str) - 【待废弃】云主机机型（V1版本概念）。参考云主机机型说明。
Zone (str) - 可用区。参见可用区列表

Response

PriceSet (list) - 见 UHostPriceSet 模型定义

Request Model

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

GetUHostInstancePriceParamVolumes

GetUHostInstancePriceParamVirtualGpu

Response Model

UHostPriceSet - ChargeType (str) - 计费类型。Year，Month，Dynamic - ListPrice (float) - 产品列表价。 - OriginalPrice (float) - 限时优惠的折前原价（即列表价乘以商务折扣后的单价）。 - Price (float) - 价格，单位: 元，保留小数点后两位有效数字

get_uhost_instance_vnc_info(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID。参见 DescribeUHostInstance 。
CPU (int) - 虚拟CPU核数。可选参数：1-64（可选范围参考控制台）。默认值为当前实例的CPU核数。
Memory (int) - 内存大小。单位：MB。范围：[1024, 262144]，取值为1024的倍数（可选范围参考控制台）。默认值为当前实例的内存大小。
NetCapValue (int) - 网卡升降级（1，表示升级，2表示降级，0表示不变）
Zone (str) - 可用区。参见可用区列表

Response

OriginalPrice (float) - 限时优惠的折前原价
Price (float) - 规格调整差价。精确到小数点后2位。

import_custom_image(req: Optional[dict] = None, **kwargs) → dict[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

import_uhost_key_pairs(req: Optional[dict] = None, **kwargs) → dict[source]¶

ImportUHostKeyPairs - 导入密钥对后，仅保管公钥部分，需自行妥善保存密钥对的私钥部分。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
KeyPairName (str) - (Required) 密钥对名称。由字母，数字，符号组成，长度为1-63位。
PublicKeyBody (str) - (Required) 密钥对的公钥内容。
Zone (str) - 可用区。参见可用区列表

Response

KeyPairFingerPrint (str) - 密钥对指纹。根据RFC4716定义的公钥指纹格式，采用MD5信息摘要算法。算法处理的具体信息格式：ProjectIdKeyPairId|PublicKeyBody。
KeyPairId (str) - 密钥对标识
KeyPairName (str) - 密钥对名称

leave_isolation_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

LeaveIsolationGroup - 移除硬件隔离组中的主机

Request

ProjectId (str) - (Config) 项目id
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 硬件隔离组id
UHostId (str) - (Required) 主机id
Zone (str) - 可用区信息

Response

UHostId (str) - 主机id

modify_uhost_instance_name(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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

modify_uhost_ip(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyUHostIP - 修改云主机内网 IP 地址

Request

ProjectId (str) - (Config) 项目ID。不填写时为默认项目。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PresentIpAddress (str) - (Required) 需要修改为的 IP 地址。新的IP地址和旧IP地址必须属于统一子网，且和主机内部的配置文件一致。
UHostId (str) - (Required) 指定云主机 ID。
Zone (str) - (Required) 可用区。参见可用区列表
PreviousIpAddress (str) - 所需修改的原 IP 地址，当云主机只有一个IP地址时，此参数不必填写。

Response

Message (str) - 输出错误的信息
UHostId (str) - 目标云主机 ID

poweroff_uhost_instance(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例资源ID 参见 DescribeUHostInstance
AutoDataDiskInit (str) - 数据盘是否需要自动分区挂载。当镜像支持Cloud-init Feature时可填写此字段。取值“On”（默认值）， “Off”
BootDiskSpace (int) - 系统盘大小。单位：GB，范围[20,100]，步长：10
ImageId (str) - 镜像Id，默认使用原镜像参见 DescribeImage
KeyPairId (str) - KeypairId 密钥对ID，LoginMode为KeyPair时此项必须。
LoginMode (str) - 主机登陆模式。密码（默认选项）: Password，密钥 KeyPair。
Password (str) - 如果重装UHost实例时LoginMode为Password，则必须填写，如果LoginMode为KeyPair，不需要填写（密码格式使用BASE64编码；举例如下：# echo -n Password1 | base64UGFzc3dvcmQx。）
ReserveDisk (str) - 是否保留数据盘，保留：Yes，不报留：No，默认：Yes；如果是从Windows重装为Linux或反之，则无法保留数据盘（该参数目前仅对本地数据盘起作用）
UserData (str) - cloudinit初始化使用。注意：1、总数据量大小不超多16K 2、使用base64编码
Zone (str) - 可用区。参见可用区列表

Response

UHostId (str) - UHost实例资源ID

reset_uhost_instance_password(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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) 可用区。参见可用区列表
DryRun (bool) - 用于测试磁盘是否支持在线扩容。DryRun=true,不会执行实际操作，只会返回操作的预期结果。DryRun = false ，正常执行扩容操作。

Response

DiskId (str) - 改配成功的磁盘id
NeedRestart (bool) - 扩容后的状态。NeedRestart = true，必须关闭后启动实例才能使用扩容的磁盘空间。NeedRestart = false,磁盘扩容后无需重启操作。

resize_uhost_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

ResizeUHostInstance - 修改指定UHost实例的资源配置，如CPU核心数，内存容量大小，网络增强等。可选配置范围请参考云主机机型说明。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost实例ID 参见 DescribeUHostInstance
CPU (int) - 虚拟CPU核数。可选参数：1-240（可选范围与UHostType相关）。默认值为当前实例的CPU核数
Memory (int) - 内存大小。单位：MB。范围：[1024, 1966080]，取值为1024的倍数（可选范围与UHostType相关）。默认值为当前实例的内存大小。
NetCapValue (int) - 网卡升降级（1，表示升级，2表示降级，0表示不变）
Zone (str) - 可用区。参见可用区列表

Response

UHostId (str) - UHost实例ID

start_uhost_instance(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

TerminateCustomImage - 删除用户自定义镜像

Request

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

Response

ImageId (str) - 自制镜像Id

terminate_uhost_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
UHostId (str) - (Required) UHost资源Id 参见 DescribeUHostInstance
ReleaseEIP (bool) - 删除主机时是否释放绑定的EIP。默认为false。
ReleaseUDisk (bool) - 删除主机时是否同时删除挂载的数据盘。默认为false。
Zone (str) - 可用区。参见可用区列表

Response

InRecycle (str) - 用于判断主机删除时是否进入回收站。放入回收站:”Yes”, 彻底删除：“No”。
UHostId (str) - UHost 实例 Id

upgrade_to_ark_uhost_instance(req: Optional[dict] = None, **kwargs) → dict[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: dict, transport=None, middleware=None, logger=None)[source]¶

allocate_backend(req: Optional[dict] = None, **kwargs) → dict[source]¶

AllocateBackend - 添加ULB后端资源实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ResourceId (str) - (Required) 所添加的后端资源的资源ID
ResourceType (str) - (Required) 所添加的后端资源的类型，枚举值：UHost -> 云主机；UNI -> 虚拟网卡；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器；UHybrid->混合云主机；CUBE->Cube；默认值为UHost。报文转发模式不支持UDocker、UHybrid、CUBE
ULBId (str) - (Required) 负载均衡实例的ID
VServerId (str) - (Required) VServer实例的ID
Enabled (int) - 后端实例状态开关，枚举值： 1：启用； 0：禁用默认为启用
IsBackup (int) - rs是否为backup，默认为00：普通rs1：backup的rs
Port (int) - 所添加的后端资源服务端口，取值范围[1-65535]，默认80
ResourceIP (str) - 所添加的后端服务器的资源实例IP，当ResourceType 为 UHybrid 时有效，且必填
SubnetId (str) - 所添加的后端服务器所在的子网，当ResourceType 为 UHybrid 时有效，且必填
VPCId (str) - 所添加的后端服务器所在的vpc，当ResourceType 为 UHybrid 时有效，且必填
Weight (int) - 所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1

Response

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

allocate_backend_batch(req: Optional[dict] = None, **kwargs) → dict[source]¶

AllocateBackendBatch -

Request

ProjectId (str) - (Config)
Region (str) - (Config)
ULBId (str) - (Required)
VServerId (str) - (Required)
ApiVersion (int) -
Backends (list) -

Response

BackendSet (list) - 见 BackendSet 模型定义

Response Model

BackendSet - BackendId (str) - - ResourceId (str) -

bind_ssl(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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
PolicyPriority (int) - 策略优先级，1-9999
Type (str) - 内容转发匹配字段的类型

Response

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

create_ssl(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BusinessId (str) - ULB 所属的业务组ID，如果不传则使用默认的业务组
ChargeType (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费; Dynamic, 按时付费
FirewallId (str) - 防火墙ID，如果不传，则默认不绑定防火墙
InnerMode (str) - 创建的ULB是否为内网模式
ListenType (str) - ULB 监听器类型，枚举值：RequestProxy，请求代理； PacketsTransmit ，报文转发。默认为RequestProxy
OuterMode (str) - 创建的ULB是否为外网模式，默认即为外网模式
Remark (str) - 备注
SubnetId (str) - 内网ULB 所属的子网ID，如果不传则使用默认的子网
Tag (str) - 业务组
ULBName (str) - 负载均衡的名字，默认值为“ULB”
VPCId (str) - ULB所在的VPC的ID, 如果不传则使用默认的VPC

Response

IPv6AddressId (str) - IPv6地址Id
ULBId (str) - 负载均衡实例的Id

create_vserver(req: Optional[dict] = None, **kwargs) → dict[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为Path时，此字段有意义，代表HTTP检查域名
FrontendPort (int) - VServer后端端口，取值范围[1-65535]；默认值为80
ListenType (str) - 监听器类型，枚举值，RequestProxy ，请求代理；PacketsTransmit ，报文转发。默认为RequestProxy
Method (str) - VServer负载均衡模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）; WeightRoundrobin -> 加权轮询; Leastconn -> 最小连接数;Backup ->主备模式。ConsistentHash，SourcePort，ConsistentHashPort 只在报文转发中使用；Leastconn只在请求代理中使用；Roundrobin、Source和WeightRoundrobin,Backup在请求代理和报文转发中使用。默认为：”Roundrobin”
MonitorType (str) - 健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；Ping -> Ping探测；Customize -> UDP检查请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path;报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize，默认值为Ping
Path (str) - 根据MonitorType确认；当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”
RequestMsg (str) - 根据MonitorType确认；当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文
ResponseMsg (str) - 根据MonitorType确认；当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文
VServerName (str) - VServer实例名称，默认为”VServer”

Response

VServerId (str) - VServer实例的Id

delete_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeletePolicy - 删除内容转发策略

Request

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

Response

delete_ssl(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteSSL - 删除SSL证书

Request

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

Response

delete_ulb(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteULB - 删除负载均衡实例

Request

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

Response

delete_vserver(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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 - BindedTargetSet (list) - 见 SSLBindedTargetSet 模型定义 - CreateTime (int) - SSL证书的创建时间 - HashValue (str) - SSL证书的HASH值 - SSLContent (str) - SSL证书的内容 - SSLId (str) - SSL证书的Id - SSLName (str) - SSL证书的名字 - SSLType (str) - SSL证书类型，暂时只有 Pem 一种类型

SSLBindedTargetSet - ULBId (str) - VServer 所属的ULB实例的资源ID - ULBName (str) - ULB实例的名称 - VServerId (str) - SSL证书绑定到的VServer的资源ID - VServerName (str) - 对应的VServer的名字

describe_ulb(req: Optional[dict] = None, **kwargs) → dict[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

ULBSet - Bandwidth (int) - 带宽 - BandwidthType (int) - 带宽类型，枚举值为： 0，非共享带宽； 1，共享带宽 - BusinessId (str) - ULB 所属的业务组ID - CreateTime (int) - ULB的创建时间，格式为Unix Timestamp - EnableLog (int) - ULB是否开启日志功能。0，关闭；1，开启 - FirewallSet (list) - 见 FirewallSet 模型定义 - IPSet (list) - 见 ULBIPSet 模型定义 - IPVersion (str) - ULB ip类型，枚举值：IPv6 / IPv4 （内部测试，暂未对外开放） - ListenType (str) - ULB 监听器类型，枚举值：RequestProxy，请求代理； PacketsTransmit ，报文转发；Comprehensive，兼容型；Pending，未定型 - LogSet (dict) - 见 LoggerSet 模型定义 - Name (str) - 负载均衡的资源名称 - PrivateIP (str) - ULB的内网IP，当ULBType为OuterMode时，该值为空 - Remark (str) - 负载均衡的备注 - SubnetId (str) - ULB 为 InnerMode 时，ULB 所属的子网ID，默认为空 - Tag (str) - 负载均衡的业务组名称 - ULBId (str) - 负载均衡的资源ID - ULBType (str) - ULB 的类型 - VPCId (str) - ULB所在的VPC的ID - VServerSet (list) - 见 ULBVServerSet 模型定义

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

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 -> 路径检查；Ping -> Ping探测， Customize -> UDP检查请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path; 报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize - 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。 - RequestMsg (str) - 根据MonitorType确认；当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文 - ResponseMsg (str) - 根据MonitorType确认；当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文 - SSLSet (list) - 见 ULBSSLSet 模型定义 - Status (int) - VServer的运行状态。枚举值： 0 -> rs全部运行正常;1 -> rs全部运行异常；2 -> rs部分运行异常。 - VServerId (str) - VServer实例的Id - VServerName (str) - VServer实例的名字

ULBBackendSet - BackendId (str) - 后端资源实例的Id - Enabled (int) - 后端提供服务的实例启用与否，枚举值：0 禁用 1 启用 - IsBackup (int) - 是否为backup，只有当vserver的Backup属性为1时才会有此字段，说明：0：主rs1：备rs - 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) -

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

PolicyBackendSet - BackendId (str) - 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关 - ObjectId (str) - 后端资源的对象ID - Port (int) - 所添加的后端资源服务端口 - PrivateIP (str) - 后端资源的内网IP - ResourceName (str) - 后端资源的实例名称 - ResourceType (str) - 所添加的后端资源的类型，枚举值：UHost -> 云主机；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器；UHybrid->混合云主机；CUBE->Cube；UNI -> 虚拟网卡 - SubResourceId (str) - 如果资源绑定了弹性网卡，则展示弹性网卡的资源ID - SubResourceName (str) - 如果资源绑定了弹性网卡，则展示弹性网卡的资源名称 - SubResourceType (str) - “UNI”或者为空

ULBSSLSet - BindedTargetSet (list) - 见 SSLBindedTargetSet 模型定义 - CreateTime (int) - SSL证书的创建时间 - HashValue (str) - SSL证书的HASH值 - SSLContent (str) - SSL证书的内容 - SSLId (str) - SSL证书的Id - SSLName (str) - SSL证书的名字 - SSLType (str) - SSL证书类型，暂时只有 Pem 一种类型

SSLBindedTargetSet - ULBId (str) - VServer 所属的ULB实例的资源ID - ULBName (str) - ULB实例的名称 - VServerId (str) - SSL证书绑定到的VServer的资源ID - VServerName (str) - 对应的VServer的名字

LoggerSet - BucketName (str) - ulb日志上传的bucket - TokenID (str) - 上传到bucket使用的token的tokenid - TokenName (str) - bucket的token名称

FirewallSet - FirewallId (str) - 防火墙ID - FirewallName (str) - 防火墙名称

describe_ulb_simple(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeULBSimple - 获取ULB信息

Request

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

Response

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

Response Model

LoggerSet - BucketName (str) - ulb日志上传的bucket - TokenID (str) - 上传到bucket使用的token的tokenid - TokenName (str) - bucket的token名称

FirewallSet - FirewallId (str) - 防火墙ID - FirewallName (str) - 防火墙名称

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

ULBSimpleSet - Bandwidth (int) - 带宽 - BandwidthType (int) - 带宽类型，枚举值为： 0，非共享带宽； 1，共享带宽 - BusinessId (str) - ULB 所属的业务组ID - CreateTime (int) - ULB的创建时间，格式为Unix Timestamp - EnableLog (int) - ULB是否开启日志功能。0，关闭；1，开启 - FirewallSet (list) - 见 FirewallSet 模型定义 - IPSet (list) - 见 ULBIPSet 模型定义 - IPVersion (str) - ULB提供服务的IP类型。枚举值，“IPv4”,”IPv6”。默认为“IPv4” - ListenType (str) - ULB 监听器类型，枚举值：RequestProxy，请求代理； PacketsTransmit ，报文转发；Comprehensive，兼容型；Pending，未定型 - LogSet (dict) - 见 LoggerSet 模型定义 - Name (str) - 负载均衡的资源名称 - PrivateIP (str) - ULB的内网IP，当ULBType为OuterMode时，该值为空 - Remark (str) - 负载均衡的备注 - SubnetId (str) - ULB 为 InnerMode 时，ULB 所属的子网ID - Tag (str) - 负载均衡的业务组名称 - ULBId (str) - 负载均衡的资源ID - ULBType (str) - ULB 的类型（InnerMode or OuterMode） - VPCId (str) - ULB所在的VPC的ID - VServerCount (int) - ulb下vserver数量

describe_vserver(req: Optional[dict] = None, **kwargs) → dict[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

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 -> 路径检查；Ping -> Ping探测， Customize -> UDP检查请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path; 报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize - 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。 - RequestMsg (str) - 根据MonitorType确认；当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文 - ResponseMsg (str) - 根据MonitorType确认；当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文 - SSLSet (list) - 见 ULBSSLSet 模型定义 - Status (int) - VServer的运行状态。枚举值： 0 -> rs全部运行正常;1 -> rs全部运行异常；2 -> rs部分运行异常。 - VServerId (str) - VServer实例的Id - VServerName (str) - VServer实例的名字

ULBBackendSet - BackendId (str) - 后端资源实例的Id - Enabled (int) - 后端提供服务的实例启用与否，枚举值：0 禁用 1 启用 - IsBackup (int) - 是否为backup，只有当vserver的Backup属性为1时才会有此字段，说明：0：主rs1：备rs - 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) -

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

PolicyBackendSet - BackendId (str) - 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关 - ObjectId (str) - 后端资源的对象ID - Port (int) - 所添加的后端资源服务端口 - PrivateIP (str) - 后端资源的内网IP - ResourceName (str) - 后端资源的实例名称 - ResourceType (str) - 所添加的后端资源的类型，枚举值：UHost -> 云主机；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器；UHybrid->混合云主机；CUBE->Cube；UNI -> 虚拟网卡 - SubResourceId (str) - 如果资源绑定了弹性网卡，则展示弹性网卡的资源ID - SubResourceName (str) - 如果资源绑定了弹性网卡，则展示弹性网卡的资源名称 - SubResourceType (str) - “UNI”或者为空

ULBSSLSet - BindedTargetSet (list) - 见 SSLBindedTargetSet 模型定义 - CreateTime (int) - SSL证书的创建时间 - HashValue (str) - SSL证书的HASH值 - SSLContent (str) - SSL证书的内容 - SSLId (str) - SSL证书的Id - SSLName (str) - SSL证书的名字 - SSLType (str) - SSL证书类型，暂时只有 Pem 一种类型

SSLBindedTargetSet - ULBId (str) - VServer 所属的ULB实例的资源ID - ULBName (str) - ULB实例的名称 - VServerId (str) - SSL证书绑定到的VServer的资源ID - VServerName (str) - 对应的VServer的名字

release_backend(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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) - 后端实例状态开关
IsBackup (int) - 是否为backup0：主rs1：备rs默认为0
Port (int) - 后端资源服务端口，取值范围[1-65535]
Weight (int) - 所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1

Response

update_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Match (str) - (Required) 内容转发匹配字段
ULBId (str) - (Required) 需要添加内容转发策略的负载均衡实例ID
VServerId (str) - (Required) 需要添加内容转发策略的VServer实例ID，只支持请求代理模式下，HTTP或HTTPS协议的VServer
BackendId (list) - 内容转发策略应用的后端资源实例的ID，来源于 AllocateBackend 返回的 BackendId，不传表示更新转发节点为空
PolicyId (str) - 转发规则的ID，当Type为Default时，可以不传或为空
Type (str) - 内容转发匹配字段的类型，枚举值：Domain -> 域名转发规则；Path -> 路径转发规则；Default -> 默认转发规则，不传默认值Domain

Response

update_ulb_attribute(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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 -> 最小连接数；Backup -> 主备模式。ConsistentHash，SourcePort，ConsistentHashPort 只在报文转发中使用；Leastconn只在请求代理中使用；Roundrobin、Source和WeightRoundrobin,Backup在请求代理和报文转发中使用。默认为：”Roundrobin”
MonitorType (str) - 健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；Ping -> Ping探测，Customize -> UDP检查请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path;报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize，默认值为Ping
Path (str) - MonitorType 为 Path 时指定健康检查发送请求时的路径，默认为 /
PersistenceInfo (str) - 根据PersistenceType确定: None或ServerInsert, 此字段无意义; UserDefined, 则此字段传入用户自定义会话保持String. 若无此字段则不做修改
PersistenceType (str) - VServer会话保持模式，若无此字段则不做修改。枚举值：None：关闭；ServerInsert：自动生成KEY；UserDefined：用户自定义KEY。
RequestMsg (str) - 根据MonitorType确认；当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文
ResponseMsg (str) - 根据MonitorType确认；当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文
VServerName (str) - VServer实例名称，若无此字段则不做修改

Response

UMem¶

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

check_udredis_space_allowance(req: Optional[dict] = None, **kwargs) → dict[source]¶

CheckUDredisSpaceAllowance - 检查高性能UMem剩余资源，以及分片扩容前的资源预检查

Request

Region (str) - (Config) 地域。参见地域和可用区列表
Count (str) - (Required) 创建实例的数量，[1-10]
Size (int) - (Required) 创建实例的容量大小,，扩容时的分片目标容量大小
Zone (str) - (Required) 可用区。参见可用区列表
GroupId (str) - 资源ID，扩缩容时的必传参数

Response

Count (int) - 创建实例资源时，表示可创建的数量；扩容资源时，返回1表示可以扩容，0表示可用区资源不足不能扩容

check_uredis_allowance(req: Optional[dict] = None, **kwargs) → dict[source]¶

CheckURedisAllowance - 检查主备Redis的资源是否足够创建新实例，以及主备Redis的扩容资源预检查

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Count (int) - (Required) 创建实例的数量，[1-10]
Size (int) - (Required) 创建实例的容量大小, 单位:GB 目前仅支持1/2/4/8/16/32六种规格；扩缩容时，表示实例的目标资源大小
Zone (str) - (Required) 可用区。参见可用区列表
GroupId (str) - 资源ID，扩容实例资源时的必传参数
Protocol (str) -
RegionFlag (bool) - 是否是跨机房URedis(默认false)
SlaveZone (str) -

Response

Count (int) - 创建实例资源时，表示可创建的数量；扩容资源时，返回1表示可以扩容，0表示可用区资源不足不能扩容

create_umem_backup(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUMemBackup - 创建分布式redis备份

Request

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

Response

BackupId (str) - 备份Id

create_umem_cache_group(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUMemSpace - 创建UMem内存空间

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 空间名称,长度(6<=size<=63)
Size (int) - (Required) 内存大小, 单位:GB, 范围[1~1024]
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - Year , Month, Dynamic, Trial 默认: Month
CouponId (str) - 使用的代金券id
Protocol (str) - 协议:memcache, redis (默认redis).注意:redis无single类型
Quantity (int) - 购买时长默认: 1
SubnetId (str) -
Type (str) - 空间类型:single(无热备),double(热备)(默认: double)
VPCId (str) -

Response

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

create_uredis_backup(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateURedisBackup - 创建主备Redis备份

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupName (str) - (Required) 请求创建组的名称 (范围[6-63],只能包含英文、数字以及符号-和_)
GroupId (str) - (Required) 资源id
SlaveZone (str) - 跨机房URedis，slave所在可用区（必须和Zone在同一Region，且不可相同）
Zone (str) - 可用区。参见可用区列表

Response

BackupId (str) - 备份id

create_uredis_group(req: Optional[dict] = None, **kwargs) → dict[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
EnableIpV6 (bool) - 是否创建使用ipv6 资源，默认为false，或者不填，创建ipv6为true
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) - 子网ID
Tag (str) - 业务组名称
VPCId (str) - VPC的ID
Version (str) - Redis版本信息(详见DescribeURedisVersion返回结果),默认版本3.0

Response

GroupId (str) - 创建的组ID

delete_umem_cache_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUMemcacheGroup - 删除单机Memcache

Request

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

Response

delete_umem_space(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUMemSpace - 删除UMem内存空间

Request

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

Response

delete_uredis_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteURedisGroup - 删除主备redis

Request

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

Response

describe_ud_redis_proxy_info(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDRedisProxyInfo - 拉取udredis所有的代理信息

Request

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

Response

DataSet (list) - 见 UDRedisProxyInfo 模型定义

Response Model

UDRedisProxyInfo - ProxyId (str) - 代理id - ResourceId (str) - 代理资源id - State (str) - 代理状态 - Vip (str) - 代理ip

describe_ud_redis_slowlog(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDRedisSlowlog - 查询UDRedis慢日志

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
InstanceId (str) - (Required) 实例id
Zone (str) - (Required) 可用区。参见可用区列表
Limit (int) - 分页显示的条目数，默认为10

Response

DataSet (list) - 见 UDRedisSlowlogSet 模型定义
TotalCount (int) - 总条目数

Response Model

UDRedisSlowlogSet - BlockId (str) - 分片id - Command (str) - 查询命令 - SpendTime (int) - 查询消耗的时间 - StartTime (int) - 查询发生的时间

describe_umem(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUMem - 获取UMem列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Protocol (str) - (Required) 协议类型: memcache, redis
Limit (int) - 分页显示的条目数, 默认值为20
Offset (int) - 分页显示的起始偏移, 默认值为0
ResourceId (str) - 资源ID
ResourceType (str) -
Zone (str) - 可用区。参见可用区列表

Response

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

Response Model

UMemDataSet - Address (list) - 见 UMemSpaceAddressSet 模型定义 - AutoBackup (str) - 是否需要自动备份,enable,disable - BackupTime (int) - 自动备份开始时间,单位小时计,范围[0-23] - ChargeType (str) - 计费模式，Year, Month, Dynamic, Trial - ConfigId (str) - 节点的配置ID - CreateTime (int) - 创建时间 - DataSet (list) - 见 UMemSlaveDataSet 模型定义 - ExpireTime (int) - 到期时间 - HighAvailability (str) - 是否开启高可用,enable,disable - Name (str) - 资源名称 - OwnSlave (str) - 是否拥有只读Slave“Yes” 包含“No” 不包含 - Protocol (str) - 协议类型: memcache, redis - ResourceId (str) - 资源ID - ResourceType (str) - distributed: 分布式版Redis,或者分布式Memcache；single：主备版Redis,或者单机Memcache；performance：高性能版 - RewriteTime (int) - 主备redis和分布式redis运维时间0 //0点1 //1点以此类推单机版memcache不返回该项 - Role (str) - 表示实例是主库还是从库,master,slave仅主备redis返回该项参数 - Size (int) - 容量单位GB - SlaveZone (str) - 跨机房URedis，slave redis所在可用区，参见可用区列表 - State (str) - 实例状态 Starting // 创建中 Creating // 初始化中 CreateFail // 创建失败 Fail // 创建失败 Deleting // 删除中 DeleteFail // 删除失败 Running // 运行 Resizing // 容量调整中 ResizeFail // 容量调整失败 Configing // 配置中 ConfigFail // 配置失败Restarting // 重启中SetPasswordFail //设置密码失败 - SubnetId (str) - 子网 - Tag (str) - 业务组名称 - Type (str) - 空间类型:single(无热备),double(热备) - UsedSize (int) - 使用量单位MB - VPCId (str) - vpc - Version (str) - Redis版本信息 - Zone (str) - 实例所在可用区，或者master redis所在可用区，参见可用区列表

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

UMemSlaveDataSet - ChargeType (str) - 计费模式，Year, Month, Dynamic, Trial - ConfigId (str) - 节点的配置ID - CreateTime (int) - 创建时间 - ExpireTime (int) - 到期时间 - GroupId (str) - 资源id - GroupName (str) - 资源名称 - MasterGroupId (str) - 主实例id - MemorySize (int) - 实力大小 - ModifyTime (int) - 修改时间 - Name (str) - 资源名称 - Port (int) - 端口 - ResourceType (str) - distributed: 分布式版Redis,或者分布式Memcache；single：主备版Redis,或者单机Memcache；performance：高性能版 - RewriteTime (int) - 主备Redis返回运维时间 0//0点 1 //1点以此类推 - Role (str) - 表示实例是主库还是从库,master,slave - Size (int) - 容量单位GB - State (str) - 实例状态 Starting // 创建中 Creating // 初始化中 CreateFail // 创建失败 Fail // 创建失败 Deleting // 删除中 DeleteFail // 删除失败 Running // 运行 Resizing // 容量调整中 ResizeFail // 容量调整失败 Configing // 配置中 ConfigFail // 配置失败Restarting // 重启中SetPasswordFail //设置密码失败 - SubnetId (str) - 子网 - Tag (str) - 业务组名称 - UsedSize (int) - 使用量单位MB - VPCId (str) - vpc - Version (str) - Redis版本信息 - VirtualIP (str) - - Zone (str) - 实例所在可用区，或者master redis所在可用区，参见可用区列表

describe_umem_backup(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUMemBackup - 查询分布式redis备份

Request

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

Response

DataSet (list) - 见 UMemBackupSet 模型定义

Response Model

UMemBackupSet - BackupId (str) - 空间的备份ID - BackupName (str) - 备份名称 - BackupType (str) - 备份类型: auto(自动) ,manual(手动) - BlockCount (int) - 本次备份，分片的数量 - CreateTime (int) - 创建时间 - State (str) - Starting:备份中 Done:完成

describe_umem_backup_url(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUMemBackupURL - 获取分布式redis 备份下载链接

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupId (str) - (Required) 备份Id
SpaceId (str) - (Required) 资源id
Zone (str) - (Required) 可用区。参见可用区列表
BlockId (str) - 分片id

Response

BackupURL (list) - 备份url，每个分片一个下载URL

describe_umem_block_info(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUMemBlockInfo - 拉取UDRedis分片信息

Request

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

Response

DataSet (list) - 见 UMemBlockInfo 模型定义

Response Model

UMemBlockInfo - BlockId (str) - 分片id - BlockPort (int) - 分片端口 - BlockSize (int) - 容量单位GB - BlockSlotBegin (int) - 分片维护的键槽起始值 - BlockSlotEnd (int) - 分片维护的键槽结束值 - BlockState (str) - 实例状态 Starting // 创建中 Creating // 初始化中 CreateFail // 创建失败 Fail // 创建失败 Deleting // 删除中 DeleteFail // 删除失败 Running // 运行 Resizing // 容量调整中 ResizeFail // 容量调整失败 Configing // 配置中 ConfigFail // 配置失败Restarting // 重启中 SetPasswordFail //设置密码失败 - BlockUsedSize (int) - 使用量单位MB - BlockVip (str) - 分片ip

describe_umem_cache_group(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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 - ListPrice (int) - 产品列表价 - OriginalPrice (int) - 原价 - Price (int) - 总价格

describe_umem_cache_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUMemcacheUpgradePrice - 获取umemcache升级价格信息

Request

GroupId (str) - (Required) 需要升级的空间的GroupId,请参考DescribeUMemcacheGroup接口
Size (int) - (Required) 购买umemcache大小,单位:GB

Response

Price (float) - 价格，单位：元

describe_umem_price(req: Optional[dict] = None, **kwargs) → dict[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 如果不指定，则一次性获取三种计费
Quantity (int) - 购买UMem的时长，默认值为1

Response

DataSet (list) - 见 UMemPriceSet 模型定义

Response Model

UMemPriceSet - ChargeType (str) - Year， Month， Dynamic，Trial - OriginalPrice (int) - 原价 - Price (int) - 现价

describe_umem_space(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUMemSpace - 获取UMem内存空间列表

Request

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

Response

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

Response Model

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) - 可用区，参见可用区列表

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

describe_umem_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[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

OriginalPrice (int) - 原价
Price (int) - 价格

Response Model

PriceDataSet - CustomPrice (int) - - PurchaseValue (int) - - TotalPrice (int) -

describe_uredis_backup(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

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

describe_uredis_config(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeURedisConfig - 查询主备Redis所有配置文件

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RegionFlag (bool) - (Required) 是否是跨机房URedis(默认false)
Zone (str) - (Required) 可用区。参见可用区列表
ConfigId (str) - 配置文件ID
Limit (int) - 页显示的条目数, 默认值为10
Offset (int) - 页显示的起始偏移, 默认值为0
Version (str) - Redis版本号

Response

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

Response Model

URedisConfigSet - ConfigId (str) - 配置ID - CreateTime (int) - 创建时间 (UNIX时间戳) - Description (str) - 配置描述 - IsModify (str) - 置是否可以修改 - ModifyTime (int) - 修改时间 (UNIX时间戳) - Name (str) - 配置名称 - RegionFlag (bool) - 是否是跨机房URedis(默认false) - State (str) - 配置所处的状态 - Version (str) - 配置对应的Redis版本 - Zone (str) - Zone

describe_uredis_group(req: Optional[dict] = None, **kwargs) → dict[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点以此类推 - Role (str) - 实例类型 - Size (int) - 容量单位GB - SlaveZone (str) - 跨机房URedis，slave redis所在可用区，参见可用区列表 - State (str) - 状态标记 Creating // 初始化中 CreateFail // 创建失败 Deleting // 删除中 DeleteFail // 删除失败 Running // 运行 Resizing // 容量调整中 ResizeFail // 容量调整失败 Configing // 配置中 ConfigFail // 配置失败 - SubnetId (str) - subnetid - Tag (str) - 业务组名称 - Type (str) - 空间类型:single(无热备),double(热备) - UsedSize (int) - 使用量单位MB - VPCId (str) - vpcid - Version (str) - Redis版本信息 - VirtualIP (str) - 节点的虚拟IP地址 - Zone (str) - 实例所在可用区，或者master redis所在可用区，参见可用区列表

describe_uredis_price(req: Optional[dict] = None, **kwargs) → dict[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)

Response

DataSet (list) - 见 URedisPriceSet 模型定义

Response Model

URedisPriceSet - ChargeType (str) - Year， Month， Dynamic，Trial - ListPrice (int) - 产品列表价 - OriginalPrice (int) - 原价 - Price (int) - 总价格

describe_uredis_slowlog(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeURedisSlowlog - 查询URedis慢日志

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 资源ID
Zone (str) - (Required) 可用区。参见可用区列表
Limit (int) - 分页显示的条目数，默认为10

Response

DataSet (list) - 见 URedisSlowlogSet 模型定义
TotalCount (int) - 总条目数

Response Model

URedisSlowlogSet - Command (str) - 查询命令 - SpendTime (int) - 查询消耗的时间 - StartTime (int) - 查询发生的时间

describe_uredis_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeURedisUpgradePrice - 获取uredis升级价格信息

Request

Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 要升级的空间的GroupId,请参考DescribeURedisGroup接口
Size (int) - (Required) 购买uredis大小,单位:GB,范围是[1-32]
Zone (str) - 可用区。参见可用区列表

Response

Price (float) - 扩容差价，单位: 元，保留小数点后两位有效数字

describe_uredis_version(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeURedisVersion - 获取主Redis可用版本

Request

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

Response

DataSet (list) - 见 URedisVersionSet 模型定义
TotalCount (int) - 总版本个数

Response Model

URedisVersionSet - Version (str) - Redis版本

flushall_uredis_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

FlushallURedisGroup - 清除主备redis数据

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
FlushType (str) - (Required) FlushDb或FlushAll
GroupId (str) - (Required) 组的ID
Zone (str) - (Required) 可用区。参见可用区列表
DbNum (int) - 清空的db，FlushType为FlushDb，此项为必传项
OrganizationId (int) - OrganizationId
SlaveZone (str) - 跨机房URedis，slave所在可用区（必须和Zone在同一Region，且不可相同）
TopOrganizationId (int) - company_id

Response

get_umem_space_state(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUMemSpaceState - 获取UMem内存空间列表

Request

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

Response

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

i_solation_uredis_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

ISolationURedisGroup - 打开/关闭URedis

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 组的ID
TransformType (str) - (Required) UNBind(关闭)或Bind(打开)
Zone (str) - (Required) 可用区。参见可用区列表
SlaveZone (str) - 跨机房URedis，slave所在可用区（必须和Zone在同一Region，且不可相同）

Response

modify_umem_space_name(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyURedisGroupName - 修改主备redis名称

Request

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

Response

modify_uredis_group_password(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyURedisGroupPassword - 修改主备密码/重置密码

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 组的ID
Password (str) - (Required) 新密码字符串，要求长度为6~36个字符,且只能包含英文、数字以及-和下划线；并且需要base64加密；如要取消密码，此值为空字符串，
ResourceType (str) -
Zone (str) - 可用区。参见可用区列表

Response

remove_ud_redis_data(req: Optional[dict] = None, **kwargs) → dict[source]¶

RemoveUDRedisData - 清除udredis实例数据

Request

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

Response

resize_umem_space(req: Optional[dict] = None, **kwargs) → dict[source]¶

ResizeUMemSpace - 调整内存空间容量

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_uredis_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

ResizeURedisGroup - 通过调用CheckURedisAllowance接口，检查资源情况，根据不同情形来调整主备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: Optional[dict] = None, **kwargs) → dict[source]¶

RestartUMemcacheGroup - 重启单机Memcache

Request

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

Response

restart_uredis_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

RestartURedisGroup - 重启主备实例

Request

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

Response

shutdown_uredis_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

ShutdownURedisGroup - 关闭主备实例

Request

Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 资源ID

Response

start_uredis_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

StartURedisGroup - 实例关闭状态下，启动实例

Request

Region (str) - (Config) 地域。参见地域和可用区列表
GroupId (str) - (Required) 资源ID

Response

update_uredis_backup_strategy(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateURedisBackupStrategy - URedisBackupStrategy

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BackupTime (str) - (Required) 备份时间，默认为0
GroupId (str) - (Required) 组的ID
AutoBackup (str) - 是否打开默认备份功能。enable(打开)，disable(关闭)，默认enable
SlaveZone (str) - 跨机房URedis，slave所在可用区（必须和Zone在同一Region，且不可相同）
Zone (str) - 可用区。参见可用区列表

Response

UNet¶

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

allocate_eip(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。
Region (str) - (Config) 地域。
Bandwidth (int) - (Required) 弹性IP的外网带宽, 单位为Mbps. 共享带宽模式必须指定0M带宽, 非共享带宽模式必须指定非0Mbps带宽. 各地域非共享带宽的带宽范围如下：流量计费[1-300]，带宽计费[1-10000]
OperatorName (str) - (Required) 弹性IP线路，枚举值：国际线路， International；BGP线路：Bgp。使用BGP线路的地域：北京二、上海金融云、上海二、广州等，其他地域均使用国际线路。
ChargeType (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费; Dynamic, 按时付费，默认为按月付费。
CouponId (str) - 代金券ID, 默认不使用
Name (str) - 弹性IP的名称, 默认为 “EIP”
PayMode (str) - 弹性IP的计费模式. 枚举值: “Traffic”, 流量计费; “Bandwidth”, 带宽计费; “ShareBandwidth”,共享带宽模式. 默认为 “Bandwidth”.“PostAccurateBandwidth”：带宽后付费模式
Quantity (int) - 购买的时长, 默认: 1
Remark (str) - 弹性IP的备注, 默认为空
ShareBandwidthId (str) - 绑定的共享带宽Id,仅当PayMode为ShareBandwidth时有效
Tag (str) - 业务组名称, 默认为 “Default”

Response

EIPSet (list) - 见 UnetAllocateEIPSet 模型定义

Response Model

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

UnetEIPAddrSet - IP (str) - IP地址 - OperatorName (str) - 运营商信息如: 国际: International, BGP: BGP

allocate_share_bandwidth(req: Optional[dict] = None, **kwargs) → dict[source]¶

AllocateShareBandwidth - 开通共享带宽

Request

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

Response

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

associate_eip_with_share_bandwidth(req: Optional[dict] = None, **kwargs) → dict[source]¶

AssociateEIPWithShareBandwidth - 将EIP加入共享带宽

Request

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

Response

bind_eip(req: Optional[dict] = None, **kwargs) → dict[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：虚拟网卡；cube，Cube容器。如果EIP为普通带宽计费，且带宽值高于2G，则只允许绑定在快杰型云主机和ULB

Response

create_bandwidth_package(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config)
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: Optional[dict] = None, **kwargs) → dict[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（低），第六个参数为该条规则的自定义备注,bj1不支持添加备注
Remark (str) - 防火墙描述，默认为空
Tag (str) - 防火墙业务组，默认为Default

Response

FWId (str) - 防火墙ID

delete_bandwidth_package(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

delete_firewall(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteFirewall - 删除防火墙

Request

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

Response

describe_bandwidth_package(req: Optional[dict] = None, **kwargs) → dict[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

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

EIPAddrSet - IP (str) - 弹性IP地址 - OperatorName (str) - 运营商信息, 枚举值为: BGP: BGP; International: 国际.

describe_bandwidth_usage(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeEIP - 获取弹性IP信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写
Region (str) - (Config) 地域
EIPIds (list) - 弹性IP的资源ID如果为空, 则返回当前 Region中符合条件的的所有EIP
IPs (list) - IP地址，支持通过ip查询，如果ip与EIP都传，会取并集查询
Limit (int) - 数据分页值, 默认为20
Offset (int) - 数据偏移量, 默认为0

Response

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

Response Model

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]

UnetEIPAddrSet - IP (str) - IP地址 - OperatorName (str) - 运营商信息如: 国际: International, 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，虚拟网卡。

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

describe_firewall(req: Optional[dict] = None, **kwargs) → dict[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”，云主机；“uni”，虚拟网卡； “upm”，物理云主机； “hadoophost”，hadoop节点； “fortresshost”，堡垒机； “udhost”，私有专区主机；”udockhost”，容器；”dbaudit”，数据库审计.

Response

DataSet (list) - 见 FirewallDataSet 模型定义
TotalCount (int) - 防火墙资源数量

Response Model

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防火墙

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

describe_firewall_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

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

Response Model

ResourceSet - Name (str) - 名称 - PrivateIP (str) - 内网IP - Remark (str) - 备注 - ResourceID (str) - 绑定该防火墙的资源id - ResourceType (str) - 绑定防火墙组的资源类型。”unatgw”，NAT网关； “uhost”，云主机； “upm”，物理云主机； “hadoophost”，hadoop节点； “fortresshost”，堡垒机； “udhost”，私有专区主机；”udockhost”，容器；”dbaudit”，数据库审计，“uni”，虚拟网卡。 - Status (int) - 状态 - SubResourceId (str) - 资源绑定的虚拟网卡的ID - SubResourceName (str) - 资源绑定的虚拟网卡的名称 - SubResourceType (str) - 资源绑定的虚拟网卡的类型，“uni”，虚拟网卡。 - Tag (str) - 业务组 - Zone (int) - 可用区

describe_share_bandwidth(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeShareBandwidth - 获取共享带宽信息

Request

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

Response

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

Response Model

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

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

EIPAddrSet - IP (str) - 弹性IP地址 - OperatorName (str) - 运营商信息, 枚举值为: BGP: BGP; International: 国际.

describe_share_bandwidth_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeShareBandwidthPrice - 获取共享带宽价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ChargeType (str) - (Required) 付费方式, 预付费:Year 按年,Month 按月,Dynamic 按需;
ShareBandwidth (int) - (Required) 共享带宽值
OperatorName (str) - 香港地域支持：BGPPro和International。其他地域无需填写该字段
Quantity (int) - 购买数量

Response

TotalPrice (int) - 共享带宽总价格

describe_share_bandwidth_update_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeShareBandwidthUpdatePrice - 获取共享带宽升级价格

Request

Region (str) - (Config) 地域。参见地域和可用区列表
ShareBandwidth (int) - (Required) 共享带宽值
ShareBandwidthId (str) - (Required) 共享带宽Id

Response

Price (float) - 共享带宽升降级价格

disassociate_eip_with_share_bandwidth(req: Optional[dict] = None, **kwargs) → dict[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
IPVersion (str) - 共享带宽类型，IPv4或者IPv6，不传默认IPv4
PayMode (str) - 移出共享带宽后，EIP的计费模式. 枚举值: “Traffic”, 流量计费; “Bandwidth”, 带宽计费; 默认为 “Bandwidth”.

Response

disassociate_firewall(req: Optional[dict] = None, **kwargs) → dict[source]¶

DisassociateFirewall - 解绑资源上的防火墙

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
FWId (str) - (Required) 防火墙ID
ResourceId (str) - (Required) 需要解绑的资源ID
ResourceType (str) - (Required) 资源类型：ULB 表示负载均衡

Response

get_eip_pay_mode(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetEIPPayMode - 获取弹性IP计费模式

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
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: Optional[dict] = None, **kwargs) → dict[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付费方式 - OriginalPrice (float) - 弹性IP的原价，单位“元” - Price (float) - 购买弹性IP的实际价格, 单位”元” - PurchaseValue (int) - 资源有效期, 以Unix Timestamp表示

get_eip_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[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价格, 单位为”元”, 如需退费此处为负值

get_throughput_daily_billing_info(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetThroughputDailyBillingInfo - 获取流量计费EIP每日流量计费信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EIPId (str) - (Required) EIP的资源ID
EndTime (int) - (Required) 查询结束时间时间戳
StartTime (int) - (Required) 查询开始时间时间戳

Response

EIPId (str) - 资源ID
Stats (list) - 见 ThroughputDailyBillingInfo 模型定义
TotalOut (int) - 计费总流量

Response Model

ThroughputDailyBillingInfo - BillingState (str) - 是否已计费，“Yes”或者“No” - EndTime (int) - 计费结束时间 - QuantityOut (int) - 计费流量，单位“GB” - StartTime (int) - 计费开始时间

grant_firewall(req: Optional[dict] = None, **kwargs) → dict[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“，虚拟网卡，“cube”，Cube容器实例。

Response

modify_eip_bandwidth(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

release_share_bandwidth(req: Optional[dict] = None, **kwargs) → dict[source]¶

ReleaseShareBandwidth - 关闭共享带宽

Request

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

Response

resize_share_bandwidth(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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：数据库审计；

Response

update_eip_attribute(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: dict, transport=None, middleware=None, logger=None)[source]¶

create_phost(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ImageId (str) - (Required) ImageId，可以通过接口 DescribePHostImage 获取
Password (str) - (Required) 密码（密码需使用base64进行编码）
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - 计费模式，枚举值为：year, 按年付费； month,按月付费；默认为按月付费
Cluster (str) - 网络环境，可选千兆：1G ，万兆：10G，默认1G。智能网卡可以选择25G。
CouponId (str) - 代金券
Disks (list) - 见 CreatePHostParamDisks 模型定义
Name (str) - 物理机名称，默认为phost
Quantity (str) - 购买时长，1-10个月或1-10年；默认值为1。月付时，此参数传0，代表购买至月末，1代表整月。
Raid (str) - Raid配置，默认Raid10 支持:Raid0、Raid1、Raid5、Raid10，NoRaid
Remark (str) - 物理机备注，默认为空
SecurityGroupId (str) - 防火墙ID，默认：Web推荐防火墙。如何查询SecurityGroupId请参见 DescribeFirewall 。
SubnetId (str) - 子网ID，不填为默认，VPC2.0下需要填写此字段。
Tag (str) - 业务组，默认为default
Type (str) - 物理机类型，默认为：db-2(基础型-SAS-V3)
VPCId (str) - VPC ID，不填为默认，VPC2.0下需要填写此字段。
VpcIp (str) - 指定内网ip创建

Response

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

Request Model

CreatePHostParamDisks - CouponId (str) - 裸金属机型参数->云盘代金券id。不适用于系统盘。请通过DescribeCoupon接口查询，或登录用户中心查看 - IsBoot (str) - 裸金属机型参数->是否是系统盘。枚举值： True，是系统盘。 False，是数据盘（默认）。Disks数组中有且只能有一块盘是系统盘。 - Size (int) - 裸金属机型参数->磁盘大小，单位GB，必须是10GB的整数倍。系统盘20-500GB，数据盘单块盘20-32000GB。 - Type (str) - 裸金属机型参数->磁盘类型：枚举值：CLOUD_RSSD

create_phost_image(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreatePHostImage - 创建裸金属2.0用户自定义镜像

Request

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

Response

ImageId (str) - 镜像ID

describe_baremetal_machine_type(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeBaremetalMachineType - 获取裸金属机型的详细描述信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - (Required) 可用区。参见可用区列表
Type (str) - 具体机型。若不填写，则返回全部机型

Response

MachineTypes (list) - 见 PHostCloudMachineTypeSet 模型定义

Response Model

PHostClusterSet - Name (str) - 集群名。枚举值：千兆网络集群：1G；万兆网络集群：10G；智能网卡网络：25G； - StockStatus (str) - 库存状态。枚举值：有库存：Available；无库存：SoldOut

PHostComponentSet - Count (int) - 组件数量 - Name (str) - 组件名称

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

PHostCloudMachineTypeSet - CPU (dict) - 见 PHostCPUSet 模型定义 - Clusters (list) - 见 PHostClusterSet 模型定义 - Components (dict) - 见 PHostComponentSet 模型定义 - Memory (int) - 内存大小，单位MB - Type (str) - 物理云主机机型别名，全网唯一。

describe_phost(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribePHost - 获取物理机详细信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 返回数据长度，默认为20
Offset (int) - 数据偏移量，默认为0
PHostId (list) - PHost资源ID，若为空，则返回当前Region所有PHost。
UDiskIdForAttachment (str) - 要挂载的云盘id，过滤返回能被UDiskId挂载的云主机。目前主要针对rssd云盘使用
VPCId (str) - ULB使用参数，获取同VPC下机器信息。
Zone (str) - 可用区。参见可用区列表

Response

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

Response Model

PHostSet - AutoRenew (str) - 自动续费 - CPUSet (dict) - 见 PHostCPUSet 模型定义 - ChargeType (str) - 计费模式，枚举值为： Year，按年付费； Month，按月付费；默认为月付 - Cluster (str) - 网络环境。枚举值：千兆：1G ，万兆：10G - Components (str) - 组件信息（暂不支持） - CreateTime (int) - 创建时间 - DiskSet (list) - 见 PHostDescDiskSet 模型定义 - 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； > 迁移中(裸金属云盘)：Migrating - PhostClass (str) - 物理云产品类型，枚举值：LocalDisk=>代表传统本地盘机型， CloudDisk=>云盘裸金属机型 - PowerState (str) - 电源状态，on 或 off - RaidSupported (str) - 是否支持Raid。枚举值：Yes：支持；No：不支持。 - Remark (str) - 物理机备注 - SN (str) - 物理机序列号 - Tag (str) - 业务组 - Zone (str) - 可用区，参见可用区列表

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

PHostDiskSet - Count (int) - - IOCap (int) - - Name (str) - - Space (int) - - 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

PHostDescDiskSet - Count (int) - 磁盘数量 - DiskId (str) - 裸金属机型参数：磁盘ID - Drive (str) - 裸金属机型参数：磁盘盘符 - IOCap (int) - 磁盘IO性能，单位MB/s（待废弃） - IsBoot (str) - 裸金属机型参数：是否是启动盘。True/False - Name (str) - 磁盘名称，sys/data - Space (int) - 单盘大小，单位GB - Type (str) - 磁盘属性

describe_phost_image(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - (Required) 可用区。参见可用区列表
ImageId (list) - 镜像ID
ImageType (str) - 镜像类别，枚举值，Base是基础镜像；Custom是自制镜像。
Limit (int) - 返回数据长度，默认为20
MachineType (str) - 机器型号，只支持当前zone的展示机型
Offset (int) - 数据偏移量，默认为0

Response

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

Response Model

PHostImageSet - CreateTime (int) - 裸金属2.0参数。镜像创建时间。 - ImageDescription (str) - 镜像描述 - ImageId (str) - 镜像ID - ImageName (str) - 镜像名称 - ImageSize (int) - 裸金属2.0参数。镜像大小。 - ImageType (str) - 枚举值：Base=>基础镜像，Custom=>自制镜像。 - OsName (str) - 操作系统名称 - OsType (str) - 操作系统类型 - State (str) - 裸金属2.0参数。镜像当前状态。 - Support (list) - 支持的机型 - Version (str) - 当前版本

describe_phost_machine_type(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribePHostMachineType - 获取物理云机型的详细描述信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - (Required) 可用区。参见可用区列表
Type (str) - 具体机型。若不填写，则返回全部机型

Response

MachineTypes (list) - 见 PHostMachineTypeSet 模型定义

Response Model

PHostClusterSet - Name (str) - 集群名。枚举值：千兆网络集群：1G；万兆网络集群：10G；智能网卡网络：25G； - StockStatus (str) - 库存状态。枚举值：有库存：Available；无库存：SoldOut

PHostComponentSet - Count (int) - 组件数量 - Name (str) - 组件名称

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

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

PHostMachineTypeSet - CPU (dict) - 见 PHostCPUSet 模型定义 - Clusters (list) - 见 PHostClusterSet 模型定义 - Components (dict) - 见 PHostComponentSet 模型定义 - Disks (list) - 见 PHostDiskSet 模型定义 - Memory (int) - 内存大小，单位MB - RaidSupported (str) - 是否支持Raid。枚举值：支持：YES；不支持：NO - Type (str) - 物理云主机机型别名，全网唯一。

describe_phost_tags(req: Optional[dict] = None, **kwargs) → dict[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_disk_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetPhostDiskUpgradePrice - 获取物理云裸金属挂载磁盘的升级价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DiskId (str) - (Required) 磁盘ID。
DiskSpace (int) - (Required) 裸金属机型参数->磁盘大小，单位GB，必须是10GB的整数倍。系统盘20-500GB，数据盘单块盘20-32000GB。
PHostId (str) - (Required) UPHost实例ID。
Zone (str) - (Required) 可用区。参见可用区列表

Response

Price (float) - 升级差价。精度为小数点后2位。

get_phost_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetPHostPrice - 获取物理机价格列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ChargeType (str) - (Required) 计费模式，枚举值为： Year/Month
Count (int) - (Required) 购买数量，范围[1-5]
Quantity (int) - (Required) 购买时长，1-10个月或1-10年；默认值为1。月付时，此参数传0，代表购买至月末，1代表整月。
Cluster (str) - 网络环境，可选千兆：1G ；万兆：10G；25G网络：25G。
Disks (list) - 见 GetPHostPriceParamDisks 模型定义
Type (str) - 默认为：DB(数据库型)，可以通过接口 DescribePHostMachineType 获取
Zone (str) - 可用区。参见可用区列表

Response

PriceSet (list) - 见 PHostPriceSet 模型定义

Request Model

GetPHostPriceParamDisks - IsBoot (str) - 裸金属机型参数->枚举值：> True，是系统盘 > False，是数据盘（默认）。Disks数组中有且只能有一块盘是系统盘。 - Size (str) - 裸金属机型参数->磁盘大小，单位GB，必须是10GB的整数倍。系统盘20-500GB。数据盘是20-32000G。 - Type (str) - 裸金属机型参数->磁盘类型：枚举值：CLOUD_RSSD

Response Model

PHostPriceSet - ChargeType (str) - Year/Month - OriginalPrice (float) - 原价格, 单位:元, 保留小数点后两位有效数字 - Price (float) - 价格, 单位:元, 保留小数点后两位有效数字 - Product (str) - 枚举值：phost=>为主机价格，如果是云盘包括了系统盘价格。cloudDisk=>所有数据盘价格，只是裸金属机型才返回此参数。

modify_phost_image_info(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyPHostImageInfo - 修改自定义镜像名称和备注

Request

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

Response

ImageId (str) - 镜像ID

modify_phost_info(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

ReinstallPHost - 重装物理机操作系统

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PHostId (str) - (Required) PHost资源ID
Password (str) - (Required) 密码
Zone (str) - (Required) 可用区。参见可用区列表
BootDiskSpace (int) - 裸金属机型参数->系统盘大小。单位：GB，范围[20,500]，步长：10
ImageId (str) - 镜像Id，参考镜像列表，默认使用原镜像
Name (str) - 物理机名称，默认不更改
Raid (str) - 不保留数据盘重装，可选Raid
Remark (str) - 物理机备注，默认为不更改。
ReserveDisk (str) - 是否保留数据盘，保留：Yes，不报留：No，默认：Yes
Tag (str) - 业务组，默认不更改。

Response

PHostId (str) - PHost 的资源ID

reset_phost_password(req: Optional[dict] = None, **kwargs) → dict[source]¶

ResetPHostPassword - 重置裸金属实例的管理员密码

Request

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

Response

PHostId (str) - 裸金属实例ID

resize_phost_attached_disk(req: Optional[dict] = None, **kwargs) → dict[source]¶

ResizePHostAttachedDisk - 修改裸金属物理云已经挂载的云盘容量大小

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - (Required) 可用区。参见可用区列表
DiskSpace (int) - 裸金属机型参数->磁盘大小，单位GB，必须是10GB的整数倍。系统盘20-500GB，数据盘单块盘20-32000GB。
PHostId (str) - UPHost实例ID。
UDiskId (str) - 磁盘ID。

Response

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

start_phost(req: Optional[dict] = None, **kwargs) → dict[source]¶

StartPHost - 启动物理机

Request

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

Response

PHostId (str) - PHost 的资源ID

stop_phost(req: Optional[dict] = None, **kwargs) → dict[source]¶

StopPHost - 关闭物理机

Request

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

Response

PHostId (str) - PHost 的资源ID

terminate_phost(req: Optional[dict] = None, **kwargs) → dict[source]¶

TerminatePHost - 删除物理云主机

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PHostId (str) - (Required) PHost资源ID
ReleaseEIP (bool) - 是否释放绑定的EIP。true: 解绑EIP后，并释放；其他值或不填：解绑EIP。
ReleaseUDisk (bool) - 裸金属机型参数->删除主机时是否同时删除挂载的数据盘。默认为false。
Zone (str) - 可用区。参见可用区列表

Response

PHostId (str) - PHost 的资源ID

terminate_phost_image(req: Optional[dict] = None, **kwargs) → dict[source]¶

TerminatePHostImage - 删除裸金属2.0用户自定义镜像

Request

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

Response

ImageId (str) - 自制镜像ID

USMS¶

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

create_usms_signature(req: Optional[dict] = None, **kwargs) → dict[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) 签名内容
SigPurpose (int) - (Required) 签名用途，0-自用，1-他用；
SigType (int) - (Required) 签名类型，说明如下：0-公司或企业的全称或简称；1-App应用的全称或简称；2-工信部备案网站的全称或简称；3-公众号或小程序的全称或简称；4-商标名的全称或简称；5-政府/机关事业单位/其他单位的全称或简称；
International (bool) - 国内/国际短信。true:国际短信，false:国内短信，若不传值则默认该值为false
ProxyFile (str) - 短信签名授权委托文件，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB；当您是代理并使用第三方的签名时（也即SigPurpose为1-他用），该项为必填项；

Response

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

create_usms_template(req: Optional[dict] = None, **kwargs) → dict[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个字。
International (bool) - 标记是否为国际短信。true:国际短信，false:国内短信，若不传值则默认该值为false
Remark (str) - 短信模板申请原因说明，字数不超过128，每个中文、符号、英文、数字等都计为1个字。
UnsubscribeInfo (str) - 当Purpose为3时，也即会员推广类短信模板，该项必填。枚举值：TD退订、回T退订、回N退订、回TD退订、退订回T、退订回D、退订回TD、退订回复T、退订回复D、退订回复N、退订回复TD、拒收回T

Response

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

delete_usms_signature(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

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

Response

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

get_usms_send_receipt(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUSMSSendReceipt - 调用接口GetUSMSSendReceipt短信发送状态信息

Request

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

Response

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

Response Model

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

ReceiptPerPhone - CostCount (int) - 消耗短信条数 - Phone (str) - 手机号码 - ReceiptCode (str) - 状态报告编码 - ReceiptDesc (str) - 回执结果描述 - ReceiptResult (str) - 回执结果，枚举值：> 发送成功: 代表成功 > Success: 代表成功 > 发送失败: 代表失败 > Fail: 代表失败 > 状态未知: 代表未知 > Unknow: 代表未知 - ReceiptTime (int) - 回执返回时间 - UserId (str) - 自定义的业务标识ID，字符串

query_usms_signature(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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_batch_usms_message(req: Optional[dict] = None, **kwargs) → dict[source]¶

SendBatchUSMSMessage - 调用SendBatchUSMSMessage接口批量发送短信

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
TaskContent (str) - (Required) 批量发送内容，该参数是json数组的base64编码结果。发送内容json数组中，每个“模板+签名”组合作为一个子项，每个子项内支持多个号码，示例：发送内容json数组（base64编码前）：[{“TemplateId”: “UTA20212831C85C”, “SigContent”: “UCloud”, “Target”: [{“TemplateParams”: [“123456”], “Phone”: “18500000123”, “ExtendCode”: “123”, “UserId”: “456”} ] } ] 。json数组中各参数的定义：”TemplateId”:模板ID，”SigContent”短信签名内容，”Target”具体到号码粒度的发送内容。”Target”中的具体字段有：”TemplateParams”实际发送的模板参数（若使用的是无参数模板，该参数不能传值），”Phone”手机号码, “ExtendCode”短信扩展码, “UserId”自定义业务标识ID。其中必传参数为”TemplateId”, “SigContent”, “Target”（”Target”中必传参数为”Phone”）。实际调用本接口时TaskContent传值（发送内容base64编码后）为：W3siVGVtcGxhdGVJZCI6ICJVVEEyMDIxMjgzMUM4NUMiLCAiU2lnQ29udGVudCI6ICJVQ2xvdWQiLCAiVGFyZ2V0IjogW3siVGVtcGxhdGVQYXJhbXMiOiBbIjEyMzQ1NiJdLCAiUGhvbmUiOiAiMTg1MDAwMDAxMjMiLCAiRXh0ZW5kQ29kZSI6ICIxMjMiLCAiVXNlcklkIjogIjQ1NiJ9IF0gfSBdIA==

Response

Action (str) - 操作名称
FailContent (list) - 见 BatchInfo 模型定义
Message (str) - 发生错误时表示错误描述
ReqUuid (str) - 本次请求Uuid
RetCode (int) - 返回码。0表示成功，非0表示失败。
SessionNo (str) - 本次提交发送任务的唯一ID，可根据该值查询本次发送的短信列表。注：成功提交短信数大于0时，才返回该字段
SuccessCount (int) - 成功提交短信（未拆分）条数

Response Model

BatchInfo - FailureDetails (str) - 未能成功发送的详情。注：模板/签名检验失败时，该字段有效 - SigContent (str) - 签名 - Target (list) - 见 FailPhoneDetail 模型定义 - TemplateId (str) - 模板ID

FailPhoneDetail - ExtendCode (str) - 扩展号码 - FailureDetails (str) - 发送失败原因。注：若模板/签名校验失败，该字段为空 - Phone (str) - 手机号 - TemplateParams (list) - 模板参数 - UserId (str) - 用户自定义ID

send_usms_message(req: Optional[dict] = None, **kwargs) → dict[source]¶

SendUSMSMessage - 调用接口SendUSMSMessage发送短信

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PhoneNumbers (list) - (Required) 电话号码数组，电话号码格式为(60)1xxxxxxxx，()中为国际长途区号(如中国为86或0086，两种格式都支持)，后面为电话号码.若不传入国际区号，如1851623xxxx，则默认为国内手机号
SigContent (str) - (Required) 短信签名内容，请到 USMS控制台的签名管理页面查看；使用的短信签名必须是已申请并且通过审核；
TemplateId (str) - (Required) 模板ID（也即短信模板申请时的工单ID），请到 USMS控制台的模板管理页面查看；使用的短信模板必须是已申请并通过审核；
ExtendCode (str) - 短信扩展码，格式为阿拉伯数字串，默认不开通，如需开通请联系 UCloud技术支持
TemplateParams (list) - 模板可变参数，以数组的方式填写，举例，TempalteParams.0，TempalteParams.1，… 若模板中无可变参数，则该项可不填写；若模板中有可变参数，则该项为必填项，参数个数需与变量个数保持一致，否则无法发送；
UserId (str) - 自定义的业务标识ID，字符串（长度不能超过32 位），不支持单引号、表情包符号等特殊字符

Response

Message (str) - 发生错误时表示错误描述
SessionNo (str) - 本次提交发送的短信的唯一ID，可根据该值查询本次发送的短信列表
UserId (str) - 本次提交的自定义业务标识ID，仅当发送时传入有效的UserId，才返回该字段。

update_usms_signature(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
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-组织机构代码证书、社会信用代码证书；
Document (str) - 短信签名的资质证明文件URL，若未更改审核材料，则该处使用已上传审核材料的URL链接，否则使用File参数
File (str) - 短信签名的资质证明文件内容，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB。内容格式如下: [file type];[code type],[base64] 如：image/jpeg;base64,5YaF5a65
ProxyDoc (str) - 短信签名授权委托文件URL，若未更改授权委托文件，则该处填写已上传的授权委托文件的URL链接，否则使用ProxyFile参数
ProxyFile (str) - 短信签名授权委托文件内容，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB；当您是代理并使用第三方的签名时（也即SigPurpose为1-他用），该项为必填项；格式和File类似。

Response

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

update_usms_template(req: Optional[dict] = None, **kwargs) → dict[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个字，每个中文、英文、数组、符合都计为一个字

Response

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

VPC¶

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

add_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddSnatRule - 对于绑定了多个EIP的NAT网关，您可以将一个子网下的某台云主机映射到某个特定的EIP上，规则生效后，则该云主机通过该特定的EIP访问互联网。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关的ID
SnatIp (str) - (Required) EIP的ip地址,例如106.75.xx.xx
SourceIp (str) - (Required) 需要出外网的私网IP地址，例如10.9.7.xx
Name (str) - snat规则名称，默认为“出口规则”

Response

add_vpc_network(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddVPCNetwork - 添加VPC网段

Request

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

Response

add_white_list_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddWhiteListResource - 添加NAT网关白名单

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
ResourceIds (list) - (Required) 可添加白名单的资源Id

Response

allocate_secondary_ip(req: Optional[dict] = None, **kwargs) → dict[source]¶

AllocateSecondaryIp - 分配ip（用于uk8s使用）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Mac (str) - (Required) 节点mac
ObjectId (str) - (Required) 资源Id
Zone (str) - (Required) 可用区。参见可用区列表
Ip (str) - 指定Ip分配
SubnetId (str) - 子网Id（若未指定，则根据zone获取默认子网进行创建）
VPCId (str) - vpcId

Response

IpInfo (dict) - 见 IpInfo 模型定义

Response Model

IpInfo - Gateway (str) - - Ip (str) - - Mac (str) - - Mask (str) - - SubnetId (str) - - VPCId (str) -

allocate_vip(req: Optional[dict] = None, **kwargs) → dict[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_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

AssociateRouteTable - 绑定子网的路由表

Request

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

Response

clone_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

CloneRouteTable - 将现有的路由表复制为一张新的路由表

Request

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

Response

RouteTableId (str) - 复制后新的路由表资源ID

create_natgw(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNATGW - 创建NAT网关

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EIPIds (list) - (Required) NAT网关绑定的EIPId
FirewallId (str) - (Required) NAT网关绑定的防火墙Id
NATGWName (str) - (Required) NAT网关名称
SubnetworkIds (list) - (Required) NAT网关绑定的子网Id
IfOpen (int) - 白名单开关标记。0表示关闭，1表示开启。默认为0
Remark (str) - 备注。默认为空
Tag (str) - 业务组。默认为空
VPCId (str) - NAT网关所属的VPC Id。默认为Default VPC Id

Response

NATGWId (str) - 申请到的NATGateWay Id

create_natgw_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNATGWPolicy - 添加NAT网关端口转发规则

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DstIP (str) - (Required) 目标IP。填写对应的目标IP地址
DstPort (str) - (Required) 目标端口。可填写固定端口，也可填写端口范围。支持的端口范围为1-65535
NATGWId (str) - (Required) NAT网关Id
Protocol (str) - (Required) 协议类型。枚举值为：TCP、UDP
SrcEIPId (str) - (Required) 源IP。填写对应的EIP Id
SrcPort (str) - (Required) 源端口。可填写固定端口，也可填写端口范围。支持的端口范围为1-65535
PolicyName (str) - 转发策略名称。默认为空

Response

PolicyId (str) - 创建时分配的策略Id

create_network_acl(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNetworkAcl - 创建网络ACL

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclName (str) - (Required) ACL的名称
VpcId (str) - (Required) 将要创建的ACL所属VPC的ID
Description (str) - ACL的描述

Response

AclId (str) - 创建的ACL的ID

create_network_acl_association(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNetworkAclAssociation - 创建ACL的绑定关系

Request

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

Response

AssociationId (str) - 创建的绑定关系的ID
PrevAssociation (dict) - 见 AssociationInfo 模型定义

Response Model

AssociationInfo - AclId (str) - ACL的ID - AssociationId (str) - 绑定ID - CreateTime (int) - 创建的Unix时间戳 - SubnetworkId (str) - 绑定的子网ID

create_network_acl_entry(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNetworkAclEntry - 创建ACL的规则

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclId (str) - (Required) ACL的ID
CidrBlock (str) - (Required) IPv4段的CIDR表示
Direction (str) - (Required) 出向或者入向（“Ingress”, “Egress”)
EntryAction (str) - (Required) 规则的行为(“Accept”, “Reject”)
IpProtocol (str) - (Required) 协议规则描述
PortRange (str) - (Required) 针对的端口范围
Priority (int) - (Required) Entry的优先级，对于同样的Direction来说，不能重复
Description (str) - 描述。长度限制为不超过32字节。
TargetResourceIds (list) - 应用目标资源列表。默认为全部资源生效。TargetType为0时不用填写该值。
TargetType (int) - 应用目标类型。0代表“子网内全部资源”，1代表“子网内指定资源”，默认为0

Response

EntryId (str) - 创建的Entry的ID

create_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateRouteTable - 创建路由表

Request

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

Response

RouteTableId (str) - 路由表ID

create_subnet(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

CreateVPC - 创建VPC

Request

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

Response

VPCId (str) - VPC资源Id

create_vpc_intercom(req: Optional[dict] = None, **kwargs) → dict[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_natgw(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNATGW - 删除NAT网关

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
ReleaseEip (bool) - 是否释放绑定的EIP。true：解绑并释放；false：只解绑不释放。默认为false

Response

delete_natgw_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNATGWPolicy - 删除NAT网关端口转发规则

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
PolicyId (str) - (Required) 端口转发规则Id

Response

delete_network_acl(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNetworkAcl - 删除网络ACL

Request

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

Response

delete_network_acl_association(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNetworkAclAssociation - 删除网络ACL绑定关系

Request

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

Response

delete_network_acl_entry(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNetworkAclEntry - 删除ACL的规则

Request

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

Response

delete_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteRouteTable - 删除自定义路由表

Request

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

Response

delete_secondary_ip(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteSecondaryIp - 删除ip（用于uk8s使用）

Request

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

Response

delete_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteSnatRule - 删除指定的出口规则（SNAT规则）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关的ID
SourceIp (str) - (Required) 需要出外网的私网IP地址，例如10.9.7.xx

Response

delete_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteSubnet - 删除子网

Request

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

Response

delete_vpc(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteVPC - 删除VPC

Request

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

Response

delete_vpc_intercom(req: Optional[dict] = None, **kwargs) → dict[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

delete_white_list_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteWhiteListResource - 删除NAT网关白名单列表

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
ResourceIds (list) - (Required) 删除白名单的资源Id

Response

describe_natgw(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNATGW - 获取NAT网关信息

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 数据分页值。默认为20
NATGWIds (list) - NAT网关Id。默认为该项目下所有NAT网关
Offset (int) - 数据偏移量。默认为0

Response

DataSet (list) - 见 NatGatewayDataSet 模型定义
TotalCount (int) - 满足条件的实例的总数

Response Model

NatGWIPResInfo - EIP (str) - 外网IP - OperatorName (str) - IP的运营商信息

NatGatewayIPSet - Bandwidth (int) - 带宽 - BandwidthType (str) - EIP带宽类型 - EIPId (str) - 外网IP的 EIPId - IPResInfo (list) - 见 NatGWIPResInfo 模型定义 - Weight (int) - 权重为100的为出口

NatGatewaySubnetSet - Subnet (str) - 子网网段 - SubnetName (str) - 子网名字 - SubnetworkId (str) - 子网id

NatGatewayDataSet - CreateTime (int) - natgw创建时间 - FirewallId (str) - 绑定的防火墙Id - IPSet (list) - 见 NatGatewayIPSet 模型定义 - NATGWId (str) - natgw id - NATGWName (str) - natgw名称 - PolicyId (list) - 转发策略Id - Remark (str) - 备注 - SubnetSet (list) - 见 NatGatewaySubnetSet 模型定义 - Tag (str) - 业务组 - VPCId (str) - 所属VPC Id

describe_natgw_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNATGWPolicy - 展示NAT网关端口转发规则

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
Limit (int) - 返回数据长度，默认为10000
Offset (int) - 列表起始位置偏移量，默认为0

Response

DataSet (list) - 见 NATGWPolicyDataSet 模型定义
TotalCount (int) - 满足条件的转发策略总数

Response Model

NATGWPolicyDataSet - DstIP (str) - 目的地址 - DstPort (str) - 目的端口 - NATGWId (str) - NAT网关Id - PolicyId (str) - 转发策略Id - PolicyName (str) - 转发策略名称 - Protocol (str) - 协议类型 - SrcEIP (str) - 端口转发前端EIP - SrcEIPId (str) - 端口转发前端EIP Id - SrcPort (str) - 源端口

describe_network_acl(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNetworkAcl - 获取网络ACL

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (str) - 列表获取的个数限制
Offset (int) - 列表偏移量
VpcId (str) - 需要获取的ACL所属的VPC的ID

Response

AclList (list) - 见 AclInfo 模型定义

Response Model

TargetResourceInfo - PrivateIp (str) - 资源内网IP - ResourceId (str) - 资源ID - ResourceName (str) - 资源名称 - ResourceType (int) - 资源类型 - SubResourceId (str) - 资源绑定的虚拟网卡的ID - SubResourceName (str) - 资源绑定的虚拟网卡的名称 - SubResourceType (int) - 资源绑定虚拟网卡的类型 - SubnetworkId (str) - 子网ID

AssociationInfo - AclId (str) - ACL的ID - AssociationId (str) - 绑定ID - CreateTime (int) - 创建的Unix时间戳 - SubnetworkId (str) - 绑定的子网ID

AclEntryInfo - CidrBlock (str) - IP段的CIDR信息 - CreateTime (int) - 创建的Unix时间戳 - Direction (str) - 出向或者入向 - EntryAction (str) - 匹配规则的动作 - EntryId (str) - Entry的ID - IpProtocol (str) - 针对的IP协议 - PortRange (str) - Port的段信息 - Priority (str) - 优先级 - TargetResourceCount (int) - 应用目标资源数量。TargetType为0时不返回该值。 - TargetResourceList (list) - 见 TargetResourceInfo 模型定义 - TargetType (int) - 应用目标类型。 0代表“子网内全部资源” ，1代表“子网内指定资源” 。 - UpdateTime (int) - 更改的Unix时间戳

AclInfo - AclId (str) - ACL的ID - AclName (str) - 名称 - Associations (list) - 见 AssociationInfo 模型定义 - CreateTime (int) - 创建的Unix时间戳 - Description (str) - 描述 - Entries (list) - 见 AclEntryInfo 模型定义 - UpdateTime (int) - 更改的Unix时间戳 - VpcId (str) - ACL所属的VPC ID

describe_network_acl_association(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNetworkAclAssociation - 获取网络ACL的绑定关系列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclId (str) - (Required) Acl的ID
Limit (str) - 列表获取的个数限制
Offset (int) - 列表偏移量

Response

AssociationList (list) - 见 AssociationInfo 模型定义

Response Model

AssociationInfo - AclId (str) - ACL的ID - AssociationId (str) - 绑定ID - CreateTime (int) - 创建的Unix时间戳 - SubnetworkId (str) - 绑定的子网ID

describe_network_acl_association_by_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNetworkAclAssociationBySubnet - 获取子网的ACL绑定信息

Request

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

Response

Association (dict) - 见 AssociationInfo 模型定义

Response Model

AssociationInfo - AclId (str) - ACL的ID - AssociationId (str) - 绑定ID - CreateTime (int) - 创建的Unix时间戳 - SubnetworkId (str) - 绑定的子网ID

describe_network_acl_entry(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNetworkAclEntry - 获取ACL的规则信息

Request

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

Response

EntryList (list) - 见 AclEntryInfo 模型定义

Response Model

TargetResourceInfo - PrivateIp (str) - 资源内网IP - ResourceId (str) - 资源ID - ResourceName (str) - 资源名称 - ResourceType (int) - 资源类型 - SubResourceId (str) - 资源绑定的虚拟网卡的ID - SubResourceName (str) - 资源绑定的虚拟网卡的名称 - SubResourceType (int) - 资源绑定虚拟网卡的类型 - SubnetworkId (str) - 子网ID

AclEntryInfo - CidrBlock (str) - IP段的CIDR信息 - CreateTime (int) - 创建的Unix时间戳 - Direction (str) - 出向或者入向 - EntryAction (str) - 匹配规则的动作 - EntryId (str) - Entry的ID - IpProtocol (str) - 针对的IP协议 - PortRange (str) - Port的段信息 - Priority (str) - 优先级 - TargetResourceCount (int) - 应用目标资源数量。TargetType为0时不返回该值。 - TargetResourceList (list) - 见 TargetResourceInfo 模型定义 - TargetType (int) - 应用目标类型。 0代表“子网内全部资源” ，1代表“子网内指定资源” 。 - UpdateTime (int) - 更改的Unix时间戳

describe_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BusinessId (str) - 业务组ID
Limit (int) - 数据分页值。默认为20
OffSet (int) - 数据偏移量。默认为0
RouteTableId (str) - 路由表资源ID
VPCId (str) - 所属VPC的资源ID

Response

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

Response Model

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

RouteRuleInfo - AccountId (int) - 项目ID信息 - DstAddr (str) - 目的地址 - DstPort (int) - 保留字段，暂未使用 - NexthopId (str) - 路由下一跳资源ID - NexthopType (str) - 路由表下一跳类型。LOCAL，本VPC内部通信路由；PUBLIC，公共服务路由；CNAT，外网路由；UDPN，跨域高速通道路由；HYBRIDGW，混合云路由；INSTANCE，实例路由；VNET，VPC联通路由；IPSEC VPN，指向VPN网关的路由。 - OriginAddr (str) - 保留字段，暂未使用 - Priority (int) - 保留字段，暂未使用 - Remark (str) - 路由规则备注 - RouteRuleId (str) - 规则ID - RouteTableId (str) - 路由表资源ID - RuleType (int) - 路由规则类型。0，系统路由规则；1，自定义路由规则 - SrcAddr (str) - 保留字段，暂未使用 - SrcPort (int) - 保留字段，暂未使用 - VNetId (str) - 所属的VPC

describe_secondary_ip(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeSecondaryIp - 查询SecondaryIp（uk8s使用）

Request

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

Response

DataSet (list) - 见 IpInfo 模型定义

Response Model

IpInfo - Gateway (str) - - Ip (str) - - Mac (str) - - Mask (str) - - SubnetId (str) - - VPCId (str) -

describe_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeSnatRule - 获取Nat网关的出口规则（SNAT规则）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关的ID
Limit (str) - 分页，默认为20
Offset (str) - 偏移，默认为0
SnatIp (str) - EIP的ip地址,例如106.75.xx.xx
SourceIp (str) - 需要出外网的私网IP地址，例如10.9.7.xx

Response

DataSet (list) - 见 NATGWSnatRule 模型定义
TotalCount (int) - 规则数量

Response Model

NATGWSnatRule - Name (str) - snat规则名称 - SnatIp (str) - EIP地址，如106.76.xx.xx - SourceIp (str) - 资源的内网IP地址 - SubnetworkId (str) - SourceIp所属的子网id

describe_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeSubnet - 获取子网信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
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: Optional[dict] = None, **kwargs) → dict[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 - Name (str) - 名称 - ResourceId (str) - 资源Id - ResourceType (str) - 资源类型。对应的资源类型：UHOST，云主机；PHOST，物理云主机；ULB，负载均衡；UHADOOP_HOST，hadoop节点；UFORTRESS_HOST，堡垒机；UNATGW，NAT网关；UKAFKA，分布式消息系统；UMEM，内存存储；DOCKER，容器集群；UDB，数据库；UDW，数据仓库；VIP，内网VIP.

describe_vip(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeVIP - 获取内网VIP详细信息

Request

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

Response

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

Response Model

VIPDetailSet - CreateTime (int) - 创建时间 - Name (str) - VIP名称 - RealIp (str) - 真实主机ip - Remark (str) - VIP备注 - SubnetId (str) - 子网id - Tag (str) - VIP所属业务组 - VIP (str) - 虚拟ip - VIPId (str) - 虚拟ip id - VPCId (str) - VPC id - Zone (str) - 地域

describe_vpc(req: Optional[dict] = None, **kwargs) → dict[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

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

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

describe_vpc_intercom(req: Optional[dict] = None, **kwargs) → dict[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 - AccountId (int) - 项目Id（数字） - DstRegion (str) - 所属地域 - Name (str) - VPC名字 - Network (list) - VPC的地址空间 - ProjectId (str) - 项目Id - Tag (str) - 业务组（未分组显示为 Default） - VPCId (str) - VPCId - VPCType (int) - vpc类型（1表示托管VPC，0表示公有云VPC）

describe_white_list_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeWhiteListResource - 展示NAT网关白名单资源列表

Request

ProjectId (str) - (Config) 项目id
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWIds (list) - (Required) NAT网关的Id
Limit (int) - 数据分页值, 默认为20
Offset (int) - 数据偏移量, 默认为0

Response

DataSet (list) - 见 NatGWWhitelistDataSet 模型定义
TotalCount (int) - 上述DataSet总数量

Response Model

DescribeWhiteListResourceObjectIPInfo - GwType (str) - natgw字符串 - PrivateIP (str) - 白名单资源的内网IP - ResourceId (str) - 白名单资源Id信息 - ResourceName (str) - 白名单资源名称 - ResourceType (str) - 白名单资源类型 - SubResourceId (str) - 资源绑定的虚拟网卡的实例ID - SubResourceName (str) - 资源绑定的虚拟网卡的实例名称 - SubResourceType (str) - 资源绑定的虚拟网卡的类型 - VPCId (str) - 白名单资源所属VPCId

NatGWWhitelistDataSet - IfOpen (int) - 白名单开关标记 - NATGWId (str) - NATGateWay Id - ObjectIPInfo (list) - 见 DescribeWhiteListResourceObjectIPInfo 模型定义

enable_white_list(req: Optional[dict] = None, **kwargs) → dict[source]¶

EnableWhiteList - 修改NAT网关白名单开关

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
IfOpen (int) - (Required) 白名单开关标记。0：关闭；1：开启。默认为0
NATGWId (str) - (Required) NAT网关Id

Response

get_available_resource_for_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetAvailableResourceForPolicy - 获取NAT网关可配置端口转发规则的资源信息

Request

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

Response

DataSet (list) - 见 GetAvailableResourceForPolicyDataSet 模型定义

Response Model

GetAvailableResourceForPolicyDataSet - PrivateIP (str) - 资源对应的内网Ip - ResourceId (str) - 资源的Id - ResourceType (str) - 资源类型。”uhost”：云主机； “upm”，物理云主机； “hadoophost”：hadoop节点； “fortresshost”：堡垒机： “udockhost”，容器

get_available_resource_for_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetAvailableResourceForSnatRule - 获取可用于添加snat规则（出口规则）的资源列表

Request

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

Response

Action (str) - 操作名称
DataSet (list) - 见 GetAvailableResourceForSnatRuleDataSet 模型定义
RetCode (str) - 返回值
TotalCount (int) - 总数

Response Model

GetAvailableResourceForSnatRuleDataSet - PrivateIP (str) - 资源内网IP - ResourceId (str) - 资源ID - ResourceName (str) - 资源名称 - ResourceType (str) - 资源类型 - SubnetworkId (str) - 资源所属VPC的ID - VPCId (str) - 资源所属子网的ID

get_available_resource_for_white_list(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetAvailableResourceForWhiteList - 获取NAT网关可添加白名单的资源

Request

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

Response

DataSet (list) - 见 GetAvailableResourceForWhiteListDataSet 模型定义
TotalCount (int) - 白名单资源列表的总的个数

Response Model

GetAvailableResourceForWhiteListDataSet - PrivateIP (str) - 资源的内网Ip - ResourceId (str) - 资源类型Id - ResourceName (str) - 资源名称 - ResourceType (str) - 资源类型。”uhost”：云主机； “upm”，物理云主机； “hadoophost”：hadoop节点； “fortresshost”：堡垒机： “udockhost”，容器 - SubResourceId (str) - 资源绑定的虚拟网卡的实例ID - SubResourceName (str) - 资源绑定的虚拟网卡的实例名称 - SubResourceType (str) - 资源绑定的虚拟网卡的实例类型 - SubnetworkId (str) - 资源所属子网Id - VPCId (str) - 资源所属VPCId

get_network_acl_target_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetNetworkAclTargetResource - 获取ACL规则应用目标列表

Request

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

Response

TargetResourceList (list) - 见 TargetResourceInfo 模型定义
TotalCount (int) - ACL规则应用目标资源总数

Response Model

TargetResourceInfo - PrivateIp (str) - 资源内网IP - ResourceId (str) - 资源ID - ResourceName (str) - 资源名称 - ResourceType (int) - 资源类型 - SubResourceId (str) - 资源绑定的虚拟网卡的ID - SubResourceName (str) - 资源绑定的虚拟网卡的名称 - SubResourceType (int) - 资源绑定虚拟网卡的类型 - SubnetworkId (str) - 子网ID

list_subnet_for_natgw(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListSubnetForNATGW - 展示NAT网关可绑定的子网列表

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
VPCId (str) - NAT网关所属VPC Id。默认值为Default VPC Id

Response

DataSet (list) - 见 NatgwSubnetDataSet 模型定义

Response Model

NatgwSubnetDataSet - HasNATGW (bool) - 是否绑定NATGW - Netmask (str) - 掩码 - Subnet (str) - 子网网段 - SubnetId (str) - 子网id - SubnetName (str) - 子网名字

modify_route_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyRouteRule - 路由策略增、删、改

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RouteRule (list) - (Required) 格式: RouteRuleId | 目的网段 | 下一跳类型（支持INSTANCE、VIP） | 下一跳 |优先级（保留字段，填写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

release_vip(req: Optional[dict] = None, **kwargs) → dict[source]¶

ReleaseVIP - 释放VIP资源

Request

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

Response

set_gw_default_export(req: Optional[dict] = None, **kwargs) → dict[source]¶

SetGwDefaultExport - 设置NAT网关的默认出口

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
ExportEipId (str) - NAT网关绑定的EIP Id。ExportIp和ExportEipId必填一个
ExportIp (str) - NAT网关绑定的EIP。ExportIp和ExportEipId必填一个

Response

update_natgw_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateNATGWPolicy - 更新NAT网关端口转发规则

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DstIP (str) - (Required) 目标IP。填写对饮的目标IP地址
DstPort (str) - (Required) 目标端口。可填写固定端口，也可填写端口范围。支持的端口范围为1-65535
NATGWId (str) - (Required) NAT网关Id
PolicyId (str) - (Required) 转发策略Id
Protocol (str) - (Required) 协议类型。枚举值为：TCP 、 UDP
SrcEIPId (str) - (Required) 源IP。填写对应的EIP Id
SrcPort (str) - (Required) 源端口。可填写固定端口，也可填写端口范围。支持的端口范围为1-6553
PolicyName (str) - 转发策略名称。默认为空

Response

update_natgw_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateNATGWSubnet - 更新NAT网关绑定的子网

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
SubnetworkIds (list) - (Required) NAT网关绑定的子网Id

Response

update_network_acl(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateNetworkAcl - 更改ACL

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclId (str) - (Required) 需要更改的ACL ID
AclName (str) - (Required) Acl的名称
Description (str) - (Required) 描述

Response

update_network_acl_entry(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateNetworkAclEntry - 更新ACL的规则

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclId (str) - (Required) ACL的ID
CidrBlock (str) - (Required) IPv4段的CIDR表示
Direction (str) - (Required) 出向或者入向（“Ingress”, “Egress”)
EntryAction (str) - (Required) 规则的行为(“Accept”, “Reject”)
EntryId (str) - (Required) 需要更新的Entry Id
IpProtocol (str) - (Required) 针对的协议规则
PortRange (str) - (Required) 针对的端口范围
Priority (int) - (Required) Entry的优先级，对于同样的Direction来说，不能重复
Description (str) - 描述
TargetResourceIds (list) - 应用目标资源列表。默认为全部资源生效。TargetType为0时不用填写该值
TargetType (int) - 应用目标类型。0代表“子网内全部资源”， 1代表“子网内指定资源”。默认为0

Response

update_route_table_attribute(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateRouteTableAttribute - 更新路由表基本信息

Request

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

Response

update_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateSnatRule - 更新指定的出口规则（SNAT规则）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关的ID，
SnatIp (str) - (Required) EIP的ip地址,例如106.75.xx.xx
SourceIp (str) - (Required) 需要出外网的私网IP地址，例如10.9.7.xx
Name (str) - snat名称，即出口规则名称

Response

update_subnet_attribute(req: Optional[dict] = None, **kwargs) → dict[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_vip_attribute(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateVIPAttribute - 更新VIP信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
VIPId (str) - (Required) 内网VIP的资源Id
Name (str) - 内网VIP的名称
Remark (str) - 内网VIP的备注
Tag (str) - 内网VIP所属的业务组

Response

update_vpc_network(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateVPCNetwork - 更新VPC网段

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Network (list) - (Required) 需要保留的VPC网段。当前仅支持删除VPC网段，添加网段请参考 AddVPCNetwork
VPCId (str) - (Required) VPC的ID

Response

Cube¶

class ucloud.services.cube.client.CubeClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

create_cube_deployment(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateCubeDeployment - 创建Cube的Deployment

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Deployment (str) - (Required) base64编码的Deployment的yaml。大小不超过16KB
SubnetId (str) - (Required) 子网Id
VPCId (str) - (Required) VPCId
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - 计费模式。枚举值为： > Year，按年付费； > Month，按月付费；> Postpay，后付费；默认为后付费
CpuPlatform (str) - Cpu平台（V6：Intel、A2：AMD），默认V6。支持的地域（北京2B、北京2E、上海2A、广东、香港、东京）目前北京2E仅有A2，其余地域仅有V6
KubeConfig (str) - base64编码的kubeconfig。大小不超过16KB
Name (str) - Deployment名称
Quantity (int) - 购买时长。默认:值 1。月付时，此参数传0，代表购买至月末。
Tag (str) - 业务组。默认：Default（Default即为未分组）

Response

Deployment (str) - 经过base64编码的Deployment的yaml
DeploymentId (str) - 控制器ID

create_cube_pod(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateCubePod - 创建Pod

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Pod (str) - (Required) base64编码的Pod的yaml。大小不超过16KB
SubnetId (str) - (Required) 子网Id
VPCId (str) - (Required) VPCId
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - 计费模式。枚举值为： > Year，按年付费； > Month，按月付费；> Postpay，后付费；默认为后付费
CouponId (str) - 代金券ID。请通过DescribeCoupon接口查询，或登录用户中心查看
CpuPlatform (str) - Cpu平台（V6：Intel、A2：AMD、Auto），默认Auto。支持的地域（北京2B、北京2E、上海2A、广东、香港、东京）目前北京2E仅有A2，其余地域仅有V6
Group (str) - pod所在组
KubeConfig (str) - base64编码的kubeconfig。大小不超过16KB
Name (str) - pod的名字
Quantity (int) - 购买时长。默认:值 1。月付时，此参数传0，代表购买至月末。
Tag (str) - 业务组。默认：Default（Default即为未分组）

Response

CubeId (str) - cube的资源Id
Pod (str) - base64编码的yaml

delete_cube_deployment(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteCubeDeployment - 删除Cube的Deployment

Request

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

Response

delete_cube_pod(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteCubePod - 删除Pod

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
CubeId (str) - cubeid和uid任意一个（必须）
ReleaseEIP (bool) - 删除cube时是否释放绑定的EIP。默认为false。
Uid (str) - cubeid和uid任意一个（必须）
Zone (str) - 可用区。参见可用区列表

Response

get_cube_deployment(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetCubeDeployment - 获取Deployment的详细信息

Request

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

Response

Deployment (str) - 经过base64编码的Deployment的yaml

get_cube_exec_token(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetCubeExecToken - 获取登录容器的token

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ContainerName (str) - (Required) 容器名称
CubeId (str) - CubeId 和 Uid 中必须填写任意一个。CubeId 是所有 Cube 资源的唯一 ID，如非在 UK8S 通过 Virtual Kubelet 插件创建的 Cube，则必填 CubeId
Uid (str) - CubeId 和 Uid 中必须填写任意一个。Uid 是在 UK8S 中通过 Virtual Kubelet 插件创建出的 Cube 的唯一标识
Zone (str) - 可用区。参见可用区列表

Response

TerminalUrl (str) - terminal的登录连接地址，限单点登录，有效时间5min
Token (str) - 有效时间5min

get_cube_extend_info(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetCubeExtendInfo - 获取Cube的额外信息

Request

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

Response

ExtendInfo (list) - 见 CubeExtendInfo 模型定义

Response Model

CubeExtendInfo - CubeId (str) - Cube的Id - Eip (list) - 见 EIPSet 模型定义 - Expiration (int) - 资源有效期 - Name (str) - Cube的名称 - Tag (str) - 业务组名称

EIPSet - Bandwidth (int) - EIP带宽值 - BandwidthType (int) - 带宽类型0标准普通带宽，1表示共享带宽 - CreateTime (int) - EIP创建时间 - EIPAddr (list) - 见 EIPAddr 模型定义 - EIPId (str) - EIPId - PayMode (str) - 付费模式，带宽付费或者流量付费 - Resource (str) - EIP绑定对象的资源Id - Status (str) - EIP状态，表示使用中或者空闲 - Weight (int) - EIP权重

EIPAddr - IP (str) - IP地址 - OperatorName (str) - 线路名称BGP或者internalation

get_cube_metrics(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetCubeMetrics - 获取Cube实例（Pod，PodX，Deploy等）监控数据时间序列

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BeginTime (int) - (Required) 开始时间
ContainerName (str) - (Required) Pod内容器名称
EndTime (int) - (Required) 结束时间，必须大于开始时间
MetricName (list) - (Required) 监控指标名称
ResourceId (str) - (Required) Cube实例资源ID
Zone (str) - (Required) 可用区。参见可用区列表

Response

DataSets (list) - 见 MetricDataSet 模型定义
Message (str) - 错误信息

Response Model

MetricDataSet - MetricName (str) - - Values (list) - 见 ValueSet 模型定义

ValueSet - Timestamp (int) - - Value (float) -

get_cube_pod(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetCubePod - 获取Pod的详细信息

Request

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

Response

Pod (str) - base64编码的pod的yaml

get_cube_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetCubePrice - 获取cube的价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ChargeType (str) - (Required) 计费模式。枚举值为： > Year，按年付费； > Month，按月付费；> Dynamic，按小时预付费 > Postpay，按秒后付费，默认为月付
Count (str) - (Required) 购买数量
Cpu (str) - (Required) CPU 配置，单位为毫核，例如如 1 核则须输入 1000
Mem (str) - (Required) 内存配置，单位为 Mi，例如 1Gi 须输入 1024
Quantity (int) - (Required) 购买时长。默认:值 1。按小时购买（Dynamic/Postpay）时无需此参数。月付时，此参数传0，代表购买至月末。
Zone (str) - (Required) 可用区。参见可用区列表

Response

OriginalPrice (int) - 列表价格，单位为分
Price (int) - 折扣后价格，单位为分

get_cube_token(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetCubeToken - 获取Cube的token，可用于terminal登录、log获取

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ContainerName (str) - (Required) 容器名称
CubeId (str) - CubeId 和 Uid 中必须填写任意一个。CubeId 是所有 Cube 资源的唯一 ID，如非在 UK8S 通过 Virtual Kubelet 插件创建的 Cube，则必填 CubeId
Uid (str) - CubeId 和 Uid 中必须填写任意一个。Uid 是在 UK8S 中通过 Virtual Kubelet 插件创建出的 Cube 的唯一标识
Zone (str) - 可用区。参见可用区列表

Response

Token (str) - 有效时间5min

list_cube_deployment(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListCubeDeployment - 获取Cube的Deployment列表

Request

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

Response

Deployments (list) - DeploymentInfo
TotalCount (int) -

list_cube_pod(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListCubePod - 获取Pods列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DeploymentId (str) - Deployment的Id
Group (str) - 组名称
Limit (int) - 默认20
Offset (int) - 默认0
SubnetId (str) - 子网Id
VPCId (str) - VPC的Id
Zone (str) - 可用区。参见可用区列表

Response

Pods (list) - Pod列表，每条数据都做了base64编码
TotalCount (int) - Cube的总数

modify_cube_extend_info(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyCubeExtendInfo - 修改Cube额外信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
CubeId (str) - (Required) cube的id
Name (str) - 修改的名字，规则（^[a-zA-Z0-9-_.一-龥]{1,32}）
Zone (str) - 可用区。参见可用区列表

Response

modify_cube_tag(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyCubeTag - 修改业务组名字

Request

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

Response

CubeId (str) - CubeId

renew_cube_pod(req: Optional[dict] = None, **kwargs) → dict[source]¶

RenewCubePod - 更新Pod

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
CubeId (str) - (Required) 容器Id
Pod (str) - (Required) base64编码的Pod的yaml
Zone (str) - 可用区。参见可用区列表

Response

Pod (str) - base64编码过的yaml，需要解码获取信息

update_cube_deployment(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateCubeDeployment - 更新Deployment

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Deployment (str) - (Required) base64编码的Deployment的yaml。大小不超过16KB
DeploymentId (str) - (Required) Deployment的Id
Name (str) - Deployment的name
Zone (str) - 可用区。参见可用区列表

Response

Deployment (str) - 经过base64编码的Deployment的yaml

IAM¶

class ucloud.services.iam.client.IAMClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

create_project(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateProject - 创建项目

Request

ProjectName (str) - (Required) 项目名称，不得与现有项目重名

Response

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

delete_project(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteProject - 删除项目

Request

ProjectID (str) - (Required) 项目ID

Response

Message (str) - 错误消息

IPSecVPN¶

class ucloud.services.ipsecvpn.client.IPSecVPNClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

create_remote_vpn_gateway(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateRemoteVPNGateway - 创建客户VPN网关

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RemoteVPNGatewayAddr (str) - (Required) 客户VPN网关地址
RemoteVPNGatewayName (str) - (Required) 客户VPN网关名称
Remark (str) - 备注，默认为空
Tag (str) - 业务组名称，默认为 “Default”

Response

RemoteVPNGatewayId (str) - 新建客户VPN网关的资源ID

create_vpn_gateway(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateVPNGateway - 创建VPN网关

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Grade (str) - (Required) 购买的VPN网关规格，枚举值为: Standard, 标准型; Enhanced, 增强型
VPCId (str) - (Required) 新建VPN网关所属VPC的资源ID
VPNGatewayName (str) - (Required) 新建VPN网关名称
BusinessId (str) - 业务组ID
ChargeType (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费；Dynamic, 按需付费(需开启权限)；Trial, 试用(需开启权限)；默认为按月付费
CouponId (str) - 代金券ID, 默认不使用
EIPId (str) - 若要绑定EIP，在此填上EIP的资源ID
Quantity (int) - 购买时长, 默认: 1
Remark (str) - 备注，默认为空
Tag (str) - 业务组名称，默认为 “Default”

Response

VPNGatewayId (str) - 新建VPN网关的资源ID

create_vpn_tunnel(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateVPNTunnel - 创建VPN隧道

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
IKEPreSharedKey (str) - (Required) 预共享密钥
IKEVersion (str) - (Required) ike版本，枚举值： “IKE V1”，”IKE V2”，默认v1
IPSecLocalSubnetIds (list) - (Required) 指定VPN连接的本地子网的资源ID，最多可填写10个。
IPSecRemoteSubnets (list) - (Required) 指定VPN连接的客户网段，最多可填写20个。
RemoteVPNGatewayId (str) - (Required) 客户VPN网关的资源ID
VPCId (str) - (Required) vpcId
VPNGatewayId (str) - (Required) VPN网关的资源ID
VPNTunnelName (str) - (Required) VPN隧道名称
IKEAuthenticationAlgorithm (str) - IKE协商过程中使用的认证算法，”md5”, “sha1”, “sha2-256”。默认值为“sha1”
IKEDhGroup (str) - IKE协商过程中使用的DH组，枚举值，”1”, “2”, “5”, “14”, “15”, “16”。默认为“15”
IKEEncryptionAlgorithm (str) - IKE协商过程中使用的加密算法，枚举值，”aes128”, “aes192”, “aes256”, “aes512”, “3des”。默认值为“aes128”
IKEExchangeMode (str) - IKE协商过程中使用的模式，枚举值，主模式，“main”；野蛮模式，“aggressive”。IKEV1默认为主模式“main”，IKEV2时不使用该参数。
IKELocalId (str) - 本端标识。枚举值，自动识别，“auto”；IP地址或域名。默认为自动识别“auto”。IKEV2必填该参数
IKERemoteId (str) - 客户端标识。枚举值，自动识别，“auto”；IP地址或域名。默认为“自动识别“auto”。IKEV2必填该参数
IKESALifetime (str) - IKE中SA的生存时间，可填写范围为600-604800。默认为86400。
IPSecAuthenticationAlgorithm (str) - IPSec隧道中使用的认证算法，枚举值，”md5”, “sha1”。默认值为“sha1”
IPSecEncryptionAlgorithm (str) - IPSec隧道中使用的加密算法，枚举值，”aes128”, “aes192”, “aes256”, “aes512”, “3des”。默认值为“aes128”
IPSecPFSDhGroup (str) - IPSec的PFS是否开启，枚举值，，不开启，”disable”；数字表示DH组, “1”, “2”, “5”, “14”, “15”, “16”。默认为“disable”。
IPSecProtocol (str) - 使用的安全协议，枚举值，“esp”，“ah”。默认为“esp”
IPSecSALifetime (str) - IPSec中SA的生存时间，可填写范围为1200 - 604800。默认为3600
IPSecSALifetimeBytes (str) - IPSec中SA的生存时间（以字节计）。可选为8000 – 20000000。默认使用SA生存时间，
Remark (str) - 备注，默认为空
Tag (str) - 业务组，默认为“Default”

Response

VPNTunnelId (str) - VPN隧道的资源ID

delete_remote_vpn_gateway(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteRemoteVPNGateway - 删除客户VPN网关

Request

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

Response

delete_vpn_gateway(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteVPNGateway - 删除VPN网关

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
VPNGatewayId (str) - (Required) VPN网关的资源ID
ReleaseEip (bool) - 删除VPN时是否一并释放EIP。false，只解绑EIP不删除EIP；true，解绑并释放EIP。默认是false

Response

delete_vpn_tunnel(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteVPNTunnel - 删除VPN隧道

Request

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

Response

describe_remote_vpn_gateway(req: Optional[dict] = None, **kwargs) → dict[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 - CreateTime (int) - 创建时间 - Remark (str) - 备注 - RemoteVPNGatewayAddr (str) - 客户网关IP地址 - RemoteVPNGatewayId (str) - 客户网关ID - RemoteVPNGatewayName (str) - 客户网关名称 - Tag (str) - 用户组 - TunnelCount (int) - 活跃的隧道数量

describe_vpn_gateway(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeVPNGateway - 获取VPN网关信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 数据分页值。默认为20
Offset (int) - 数据偏移量。默认为0
Tag (str) - 业务组名称，若指定则返回指定的业务组下的所有VPN网关的信息。
VPCId (str) - VPC的资源ID，返回指定的VPC下的所有VPN网关的信息。默认返回当前Region中所有VPN网关实例的信息
VPNGatewayIds (list) - VPN网关的资源ID，例如VPNGatewayIds.0代表希望获取VPN网关1的信息，VPNGatewayIds.1代表VPN网关2，如果为空，则返回当前Region中所有VPN网关的信息

Response

DataSet (list) - 见 VPNGatewayDataSet 模型定义
TotalCount (int) - 满足条件的VPN网关总数

Response Model

VPNGatewayDataSet - AutoRenew (str) - 是否自动续费 - ChargeType (str) - 付费类型 - CreateTime (int) - 创建时间 - EIP (str) - 绑定EIP的IP地址 - EIPId (str) - EIPID - EIPType (str) - EIP类型 - ExpireTime (int) - 到期时间 - Grade (str) - 网关类型 - Remark (str) - 网关备注 - Tag (str) - 网关业务组 - VPCId (str) - 所属VPCId - VPCName (str) - 所属VPC名字 - VPNGatewayId (str) - 网关Id - VPNGatewayName (str) - 网关名字

describe_vpn_tunnel(req: Optional[dict] = None, **kwargs) → dict[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

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) - 隧道名称

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版本

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的生存时间（以字节计）

get_vpn_gateway_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetVPNGatewayPrice - 获取VPN价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Grade (str) - (Required) VPN网关规格。枚举值，包括：标准型：Standard，增强型：Enhanced。
ChargeType (str) - 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费; Dynamic, 按需付费(需开启权限); 默认为获取三种价格
Quantity (int) - 购买时长, 默认: 1

Response

PriceSet (list) - 见 VPNGatewayPriceSet 模型定义

Response Model

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

get_vpn_gateway_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetVPNGatewayUpgradePrice - 获取VPN网关规格改动价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Grade (str) - (Required) 更改的VPN网关规格，枚举值为: Standard, 标准型; Enhanced, 增强型。
VPNGatewayId (str) - (Required) VPN网关的资源ID

Response

Price (float) - 调整规格后的VPN网关价格, 单位为”元”, 如需退费此处为负值

update_vpn_gateway(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateVPNGateway - 更改VPN网关规格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Grade (str) - (Required) 网关规格。枚举值为: Standard, 标准型; Enhanced, 增强型。
VPNGatewayId (str) - (Required) VPN网关的资源ID

Response

update_vpn_tunnel_attribute(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateVPNTunnelAttribute - 更新VPN隧道属性

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
VPNTunnelId (str) - (Required) VPN隧道的资源ID
IKEAuthenticationAlgorithm (str) - IKE协商过程中使用的认证算法
IKEDhGroup (str) - IKE协商过程中使用的DH组
IKEEncryptionAlgorithm (str) - IKE协商过程中使用的加密算法
IKEExchangeMode (str) - IKE协商过程中使用的模式，可选“主动模式”与“野蛮模式”。IKEV2不使用该参数。
IKELocalId (str) - 本端标识。不填时默认使用之前的参数，结合IKEversion进行校验，IKEV2时不能为auto。
IKEPreSharedKey (str) - 预共享密钥
IKERemoteId (str) - 客户端标识。不填时默认使用之前的参数，结合IKEversion进行校验，IKEV2时不能为auto。
IKESALifetime (str) - IKE中SA的生存时间
IKEVersion (str) - 枚举值：”IKE V1”,”IKE V2”
IPSecAuthenticationAlgorithm (str) - IPSec隧道中使用的认证算法
IPSecEncryptionAlgorithm (str) - IPSec隧道中使用的加密算法
IPSecLocalSubnetIds (list) - 指定VPN连接的本地子网的id，用逗号分隔
IPSecPFSDhGroup (str) - IPSec中的PFS是否开启
IPSecProtocol (str) - 使用的安全协议，ESP或AH
IPSecRemoteSubnets (list) - 指定VPN连接的客户网段，用逗号分隔
IPSecSALifetime (str) - IPSec中SA的生存时间
IPSecSALifetimeBytes (str) - IPSec中SA的生存时间（以字节计）

Response

ISMS¶

class ucloud.services.isms.client.ISMSClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

create_isms_signature(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateISMSSignature - 调用接口CreateISMSSignature申请视频短信签名

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) - 返回状态码描述，如果操作成功，默认返回为空
SigId (str) - 短信签名ID

create_isms_template(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateISMSTemplate - 申请视频短信模板

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Content (str) - (Required) 视频短信模板内容。json数组的字符串格式。如：[{name:”0.txt”,type:”txt”,content:”北京是一座美丽的城市，我爱北京！”,index:0},{name:”1.jpg”,type:”jpg”,content:”jpg文件字节的base64编码字符串”,index:1},{name:”2.mp4”,type:”mp4”,content:”mp4文件字节的base64编码字符串”,index:2}]。name: 文件名，name中不能出现中文，必须要带上和type相同的后缀；type:文件类型，不能为空，文本为txt，图片为jpg、gif或png，音频为mp3，视频为mp4；content：文件内容，由文本、图片、音频、视频组成，文本使用txt文件，图片使用 jpg、gif、png 格式，音频使用 mp3 格式，视频使用mp4（视频只允许一个），文本、图片、音频、视频文件合计大小不可超过2M；index: 在视频短信中的位置。从0开始。
MsgSignature (str) - (Required) 视频短信签名
MsgTitle (str) - (Required) 视频短信标题
Remark (str) - (Required) 备注
TemplateName (str) - (Required) 视频短信模板名称
UnsubscribeInfo (str) - (Required) 退订信息，如：“回T退订”
Zone (str) - 可用区。参见可用区列表

Response

Message (str) - API接口调用出错时表示错误信息
ReqUuid (str) - 本次接口调用请求Id，用于问题排查。
TemplateId (str) - 申请的模板Id。

delete_isms_signature(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteISMSSignature - 调用接口DeleteISMSSignature删除视频短信签名

Request

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

Response

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

delete_isms_template(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteISMSTemplate - 调用接口DeleteISMSTemplate删除视频短信模板

Request

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

Response

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

get_isms_send_receipt(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetISMSSendReceipt - 获取视频短信发送记录的状态回执

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
TaskIdSet (list) - (Required) 发送记录TaskId集合。调用SendUSMSVideoMessage时返回的TaskId的集合。以TaskIdSet.0、TaskIdSet.1…TaskIdSet.N的形式传入。每次请求最多支持100个
Zone (str) - (Required) 可用区。参见可用区列表

Response

Data (list) - 见 ReceiptPerTask 模型定义
Message (str) - 错误信息
ReqUuid (str) - 本次请求uuid

Response Model

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

ReceiptPerPhone - Phone (str) - 手机号码 - ReceiptCode (str) - 回执码 - ReceiptDesc (str) - 回执结果描述 - ReceiptResult (str) - 回执结果(发送成功、发送失败、状态未知) - ReceiptTime (int) - 回执返回时间 - SessionId (str) - SessionId

query_isms_signature(req: Optional[dict] = None, **kwargs) → dict[source]¶

QueryISMSSignature - 调用接口QueryISMSSignature查询视频短信签名申请状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
SigId (str) - (Required) 已申请的短信签名ID（短信签名申请时的工单ID）；签名ID和签名至少需填写1项；
SigContent (str) - 签名内容；签名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_isms_template(req: Optional[dict] = None, **kwargs) → dict[source]¶

QueryISMSTemplate - 查询模板状态信息

Request

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

Response

Data (dict) - 见 OutTemplate 模型定义
Message (str) - 错误信息
ReqUuid (str) - 本次请求uuid

Response Model

OutTemplate - CreateTime (int) - 创建时间，时间戳格式1629357838 - ExpireTime (int) - 截止有效时间，时间戳格式1629357838 - Purpose (int) - 视频短信类型（3-会员营销） - Remark (str) - 备注信息 - StatusDesc (str) - 状态描述。json格式，给出运营商维度的审核状态信息，示例：{“telecom_status”:2,”telecom_desc”:”审核通过”,”unicom_status”:2,”unicom_desc”:”审核通过”,”mobile_status”:2,”mobile_desc”:”审核通过”}。状态枚举值：0-创建模板时未向该运营商报备 1->审核中 2->审核通过 3->审核未通过 4->禁用 7->过期 11->待审核 - TemplateId (str) - 模板ID - TemplateName (str) - 模板名称

send_isms_message(req: Optional[dict] = None, **kwargs) → dict[source]¶

SendISMSMessage - 发送视频短信

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
PhoneSet (list) - (Required) 手机号码列表。暂时只支持中国大陆号码。若号码中带区号，需要将区号使用小括号包含，放在号码前面。如: (86)1851623xxxx
TemplateId (str) - (Required) 视频短信模板Id
Zone (str) - (Required) 可用区。参见可用区列表

Response

Message (str) - 错误信息
ReqUuid (str) - 本次请求uuid
TaskId (str) - 本次调用TaskId，使用该字段查询回执信息

update_isms_signature(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID，不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
SigContent (str) - (Required) 新的短信签名内容；长度为2-12个字符, 可包含中文、数字和符号；无需填写【】或[]，系统会自动添加
SigId (str) - (Required) 签名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-组织机构代码证书、社会信用代码证书；
Document (str) - 短信签名的资质证明文件URL，若未更改审核材料，则该处使用已上传审核材料的URL链接，否则使用File参数
File (str) - 短信签名的资质证明文件内容，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB。内容格式如下: [file type];[code type],[base64] 如：image/jpeg;base64,5YaF5a65
ProxyDoc (str) - 短信签名授权委托文件URL，若未更改授权委托文件，则该处填写已上传的授权委托文件的URL链接，否则使用ProxyFile参数
ProxyFile (str) - 短信签名授权委托文件内容，需先进行base64编码格式转换，此处填写转换后的字符串。文件大小不超过4 MB；当您是代理并使用第三方的签名时（也即SigPurpose为1-他用），该项为必填项；格式和File类似。

Response

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

TiDB¶

class ucloud.services.tidb.client.TiDBClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

create_ti_db_service(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateTiDBService - 创建TiDB服务

Request

ProjectId (str) - (Config) 项目 ID
Region (str) - (Config) 地域。参见地域和可用区列表
Name (str) - (Required) 服务名称，长度不超过64
Password (str) - (Required) 服务root账号的密码，长度不超过32
SubnetId (str) - (Required) 子网 ID
VPCId (str) - (Required) VPC ID
DTType (str) - 容灾类型：10:同可用区，20:跨可用区，默认是同可用区
Ip (str) - ipv4
Port (str) - 端口
TikvMemoryHardTh (str) - 实例类型: 0: 旗舰版，30: 体验版，60: 轻量版

Response

Data (dict) - 见 ServiceID 模型定义
Message (str) - 返回信息
ServiceId (str) - 服务ID

Response Model

ServiceID - Id (str) - 服务ID

delete_ti_db_service(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteTiDBService - 删除一个服务

Request

Region (str) - (Config) 地域。参见地域和可用区列表
Id (str) - (Required) 资源ID

Response

Message (str) - 返回信息
ServiceId (str) - ServiceId

set_ti_db_config(req: Optional[dict] = None, **kwargs) → dict[source]¶

SetTiDBConfig - 设置TiDB服务实例参数

Request

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

Response

ServiceId (str) - ServiceId

Request Model

SetTiDBConfigParamConfigs - Name (str) - 修改的参数名: proxysql_mysql-max_connections:类型：string, 描述: 所有用户总共的最大连接数。proxysql_max_connections: 类型：string, 描述: 每个用户的最大连接数。tidb_gc: 类型：string, 描述: tikv_gc_life_time。 - Value (str) - 对应修改的参数值: string

UBill¶

class ucloud.services.ubill.client.UBillClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

get_balance(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetBalance - 获取账户余额

Request

Response

AccountInfo (dict) - 见 AccountInfo 模型定义

Response Model

AccountInfo - Amount (str) - 账户余额 - AmountAvailable (str) - 账户可用余额 - AmountCredit (str) - 信用账户余额 - AmountFree (str) - 赠送账户余额 - AmountFreeze (str) - 冻结账户金额

get_bill_data_file_url(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetBillDataFileUrl - 生成账单数据文件下载的 url

Request

BillType (int) - (Required) 账单类型，传 0 时获取账单总览报表，传 1 获取账单明细报表
BillingCycle (str) - (Required) 账期(字符串格式，YYYY-MM，例如2021-08). 若BillingCycle 和 BillPeriod同时存在，BillingCycle 优先
BillPeriod (int) - 此字段不推荐使用，建议使用BillingCycle. 若BillingCycle 和 BillPeriod同时存在，BillingCycle 优先
PaidType (int) - 获取账单总览报表时，账单的支付状态，传 0 时获取待支付账单，传 1 时获取已支付账单。获取账单明细报表时该参数无效
RequireVersion (str) - 如需求其他语言版本的账单则使用此参数。默认中文。如 RequireVersion = “EN”，则提供英文版本账单。
Version (str) - 文件版本，若为”v1”表示获取带有子用户信息的账单，可以为空

Response

FileUrl (str) - 交易账单数据下载URL
IsValid (str) - 生成的 URL是否有效，即有对应数据文件

list_u_bill_detail(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListUBillDetail - 获取某个账期内的所有消费。

Request

BillingCycle (str) - (Required) 账期，YYYY-MM，比如2021-08，只支持2018-05之后的查询
ChargeType (str) - 计费方式 (筛选项, 默认全部)
Limit (int) - 每页数量，默认值25，最大值：100。
Offset (int) - 数据偏移量 (默认0)
OrderType (str) - 订单类型 (筛选项, 默认全部)
PaidState (int) - 支付状态 (筛选项, 1:仅显示未支付订单; 2:仅显示已支付订单; 0:两者都显示)
ProjectName (str) - 项目名称 (筛选项, 默认全部)
ResourceIds (list) - 资源ID(筛选项, 默认全部) 支持多筛选，多筛选请在请求参数中添加多个字段例ResourceIds.0: uhost-bzgf1gh5，ResourceIds.1: uhost-gu1xpspa，
ResourceTypes (list) - 产品类型 (筛选项, 默认全部),支持多筛选，多筛选请在请求参数中添加多个字段例ResourceTypes.0: uhost，ResourceTypes.1: udisk，ResourceTypes.2: udb，
ShowZero (int) - 是否显示0元订单 (0 不显示, 1 显示, 默认0)
UserEmail (str) - 用户邮箱，可以根据用户邮箱来进行筛选

Response

Items (list) - 见 BillDetailItem 模型定义
TotalCount (int) - 账单明细总长度

Response Model

ResourceExtendInfo - KeyId (str) - 资源标识健 - Value (str) - 资源标识值

ItemDetail - ProductName (str) - 产品小类名称 - Value (str) - 产品小类规格

BillDetailItem - Admin (int) - 是否为主账号 - Amount (str) - 订单总金额 - AmountCoupon (str) - 代金券抵扣 - AmountFree (str) - 赠送金额抵扣 - AmountReal (str) - 现金账户支付 - AzGroupCName (str) - 可用区 - ChargeType (str) - 计费方式 - CreateTime (int) - 创建时间（时间戳） - ItemDetails (list) - 见 ItemDetail 模型定义 - OrderNo (str) - 订单号 - OrderType (str) - 订单类型 - ProjectName (str) - 项目名称 - ResourceExtendInfo (list) - 见 ResourceExtendInfo 模型定义 - ResourceId (str) - 资源ID - ResourceType (str) - 产品类型 - ResourceTypeCode (int) - 产品类型代码 - ShowHover (int) - 订单支付状态 - StartTime (int) - 开始时间（时间戳） - UserDisplayName (str) - 账户昵称 - UserEmail (str) - 账户邮箱 - UserName (str) - 账户名

list_u_bill_overview(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListUBillOverview - 账单总览。可按产品/项目/用户纬度获取某个账期内账单总览信息。

Request

BillingCycle (str) - (Required) 账期，YYYY-MM格式，例如2022-02，只支持2018-05之后的查询
Dimension (str) - (Required) 账单维度, product 按产品聚合,project 按项目聚合，user 按子账号聚合
HideUnpaid (int) - 是否显示已入账账单, 1 已入账, 0 待入账 (默认0 )

Response

Items (list) - 见 BillOverviewItem 模型定义
TotalCount (int) - 账单总览数据总数
TotalPaidAmount (str) - 已入账订单总额（已入账时显示）
TotalPaidAmountReal (str) - 现金账户扣款总额（已入账时显示）
TotalUnpaidAmount (str) - 待入账订单总额（待入账时显示）

Response Model

BillOverviewItem - Admin (int) - 该账户是否为主账号，1 主账号，0 子账号（账单维度按子账号筛选时显示） - Amount (str) - 订单总金额 - AmountCoupon (str) - 代金券抵扣（已入账时显示） - AmountFree (str) - 赠送金额抵扣（已入账时显示） - AmountReal (str) - 现金账户支付（已入账时显示） - Dimension (str) - 账单维度, product 按产品维度聚合,project 按项目维度聚合，user 按子账号维度聚合 - ProductCategory (str) - 产品分类（账单维度按产品筛选时显示） - ProjectName (str) - 项目名称（账单维度按项目筛选时显示） - ResourceType (str) - 产品类型（账单维度按产品筛选时显示） - ResourceTypeCode (int) - 产品类型代码（账单维度按产品筛选时显示） - UserDisplayName (str) - 账户昵称（账单维度按子账号筛选时显示） - UserEmail (str) - 账户邮箱（账单维度按子账号筛选时显示） - UserName (str) - 账户名（账单维度按子账号筛选时显示）

UDDB¶

class ucloud.services.uddb.client.UDDBClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

change_uddb_instance_name(req: Optional[dict] = None, **kwargs) → dict[source]¶

ChangeUDDBInstanceName - 修改分布式数据库中间件名称

Request

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

Response

change_uddb_slave_count(req: Optional[dict] = None, **kwargs) → dict[source]¶

ChangeUDDBSlaveCount - 改变分布式数据库数据节点的只读实例个数每一个UDDB的数据节点负责处理所有的写入请求。与此同时，每一个数据节点可以配置若干个该节点的只读实例。当主节点的数据写入完毕后，只读实例把这次的写入操作进行更新，从而和数据节点保持一致。只读实例可以使得数据由多份复制，在数据节点和只读实例之间，可以做请求的读写分离, 也就是说, 主节点写入数据之后, 数据的读操作可以由数据只读实例进行分担, 这样减少主节点的压力, 增加性能当改变了数据节点的只读实例个数之后，对于现有的和以后的每一个数据节点都采用这个配置。如果UDDB实例有现有的数据节点, 那么它会根据新配置的参数，自动创建或删除数据节点的只读实例如下状态的UDDB实例可以进行这个操作:Running: 系统正常运行中当请求返回成功之后，UDDB实例的状态变成”ChangingSlaveCount”; 如果返回失败, UDDB实例状态保持不变当UDDB更改数据分区的只读实例个数成功之后, UDDB实例的状态变成”Running”(正常运行中); 如果更改过程中出现异常, 状态变成”Abnormal”(异常运行中)或者”Error”(运行错误)

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
SlaveCount (str) - (Required) 每个数据节点的只读实例个数, 取值必须>=0
UDDBId (str) - (Required) UDDB资源id
Zone (str) - (Required) 可用区。参见可用区列表

Response

create_uddb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUDDBInstance - 创建创建分布式数据库UDDB实例, 简称UDDB实例。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AdminPassword (str) - (Required) 管理员密码, 密码需要使用base64加密
DBTypeId (str) - (Required) UDDB的数据库版本，支持版本如下：mysql-5.6 mysql-5.7. 如果不填，则默认为mysql-5.6
DataNodeCount (int) - (Required) 初始的数据节点个数取值必须>0.
DataNodeDiskSpace (int) - (Required) 新的数据节点的磁盘大小配置. 单位: GB 具体数值参考UDB的磁盘大小取值.
DataNodeMemory (int) - (Required) 新的数据节点的内存配置, 单位：MB 具体数值参考UDB的内存取值.
Name (str) - (Required) 实例名称，至少6位
RouterNodeNum (int) - (Required) 其他版本：该参数可不填；专享版：物理机台数
RouterVersion (str) - (Required) UDDB路由节点的版本。分为三种： Trival(免费版)： 2中间件节点； QPS：1.5W FellFree(标准版)：固定为4中间件节点，后续将根据业务请求量自动扩展，最多扩展到12个节点，QPS为3w - 10w； EnjoyAlone(物理机版)：专享物理机，节点数让客户可选
Zone (str) - (Required) 可用区。参见可用区列表
AdminUser (str) - 管理员帐户名，默认root
ChargeType (str) - 付费类型，可选值如下:Year: 按年付费 Month: 按月付费 Dynamic: 按需付费(单位: 小时) Trial: 免费试用默认值为: Dynamic
CouponId (str) - 使用的代金券id
DataNodeSlaveCount (int) - 每个数据节点的只读实例个数, 取值必须>=0. 默认取值为0.
InstanceMode (str) - 存储节点的高可用模式，分为高可用UDB（HA）和普通UDB（Normal），如果不填，则默认为HA
InstanceType (str) - 存储节点和只读实例的磁盘类型。分为：SSD磁盘（SATA_SSD）或普通磁盘(Normal)。如果不填，则默认为SATA_SSD
Port (int) - 端口号，mysql默认端口为3306
Quantity (int) - 购买时长，默认值1
SubnetId (str) - 子网ID
VPCId (str) - VPC的ID

Response

Message (str) - 如果执行失败, 失败的错误消息
UDDBId (str) - UDDB实例ID

delete_uddb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUDDBInstance - 删除UDDB实例。如下状态的UDDB实例可以进行这个操作:InitFail: 初始化失败Shutoff: 已关闭当请求返回成功之后，UDDB实例就已经被删除, 列表上看不到对应的UDDB实例

Request

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

Response

Message (str) - 如果执行失败, 失败的错误消息

describe_uddb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDDBInstance - 获取分布式数据库UDDB的详细信息

Request

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

Response

DataSet (list) - 见 DataSetUDDB 模型定义
Message (str) - 如果执行失败, 失败的错误消息

Response Model

SlaveInfo - DataNodeId (str) - 对应数据节点的ID - Id (str) - 只读实例ID - State (str) - 只读实例状态, 状态列表如下: Init: 初始化中 Fail: 安装失败 Starting: 启动中 Running: 系统正常运行中 Shutdown: 关闭中 Shutoff: 已关闭 Deleted: 已删除 Upgrading: 系统升级中

DataNodeInfo - CreateTime (str) - 节点的创建时间 - DiskSpace (str) - 数据节点的磁盘大小配置. 单位: GB - Id (str) - 数据节点ID - LastTransTaskId (str) - 最近一次数据迁移任务id - Memory (str) - 数据节点的内存配置, 单位：MB - SlaveCount (str) - 数据节点的只读实例个数. - SlaveInfos (list) - 见 SlaveInfo 模型定义 - State (str) - 数据分片状态, 状态列表如下: Init: 初始化中 Fail: 安装失败 Starting: 启动中 Running: 系统正常运行中 Shutdown: 关闭中 Shutoff: 已关闭 Deleted: 已删除 Upgrading: 系统升级中

DataSetUDDB - AdminUser (str) - 管理员帐户名，默认root - ChargeType (str) - 付费类型，可选值如下: Year: 按年付费 Month: 按月付费 Dynamic: 按需付费(单位: 小时) Trial: 免费试用 - CreateTime (str) - UDDB实例创建时间，采用UTC计时时间戳 - DBTypeId (str) - UDDB的数据库版本 - DataNodeCount (str) - 数据节点个数 - DataNodeDiskSpace (str) - 数据节点的磁盘大小配置. 单位: GB - DataNodeList (list) - 见 DataNodeInfo 模型定义 - DataNodeMemory (str) - 数据节点的内存配置, 单位：MB - DataNodeSlaveCount (str) - 每个数据节点的只读实例个数. - ExpiredTime (str) - UDDB实例过期时间，采用UTC计时时间戳 - InstanceMode (str) - 存储节点的高可用模式，分为高可用UDB（HA）和普通UDB（Normal），如果不填，则默认为HA - InstanceType (str) - 存储节点和只读实例的磁盘类型。分为：SSD磁盘（SATA_SSD）或普通磁盘(Normal)。如果不填，则默认为SATA_SSD - Name (str) - UDDB实例名称 - Port (str) - UDDB实例访问的端口号 - RefQps (int) - 参考QPS。免费版： 15000；畅享版： 30000 - 100000 （根据节点数而定）；专享版：节点数 * 10w qps - RouterNodeNum (int) - 各版本下的节点个数。体验版：固定为2节点；畅享版：固定为4节点（后续可通过管理API调整）；专享版：物理机台数 - RouterVersion (str) - UDDB路由节点的版本。分为三种： Trival(免费版)： 2中间件节点； QPS：1.5W FellFree(标准版)：固定为4中间件节点，后续将根据业务请求量自动扩展，最多扩展到12个节点，QPS为3w - 10w； EnjoyAlone(物理机版)：专享物理机，节点数让客户可选 - State (str) - UDDB状态, 状态列表如下: Init: 初始化中 InitFail: 初始化失败 Starting: 启动中 Running: 系统正常运行中 Abnormal: 系统运行中, 有异常, 还能提供服务 Error: 系统运行中, 但不能正常提供服务 Shutdown: 关闭中 Shutoff: 已关闭 Deleted: 已删除 UpgradingUDDB: 升降级UDDB配置中 UpgradingDataNode: 升降级UDDB节点配置中 ChangingSlaveCount: 改变只读实例数量中 ScalingOutUDDB: 水平扩展中 - UDDBId (str) - UDDB实例ID - VirtualIP (str) - UDDB实例访问的虚IP - Zone (str) - UDDB实例对应的可用区

describe_uddb_instance_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDDBInstancePrice - 获取分布式数据库UDDB价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DataNodeCount (int) - (Required) 初始的数据节点个数取值必须>0.
DataNodeDiskSpace (int) - (Required) 新的数据节点的磁盘大小配置. 单位: GB 具体数值参考UDB的磁盘大小取值.
DataNodeMemory (str) - (Required) 新的数据节点的内存配置, 单位：MB 具体数值参考UDB的内存取值.
RouterNodeNum (int) - (Required) 其他版本：该参数可不填；专享版：物理机节点个数。一台物理机有2个节点
RouterVersion (str) - (Required) UDDB路由节点的版本。分为三种： Trival(免费版)： 2中间件节点； QPS：1.5WFeelFree(标准版)：固定为4中间件节点，后续将根据业务请求量自动扩展，最多扩展到12个节点，QPS为3w - 10w；EnjoyAlone(物理机版)：专享物理机，节点数让客户可选
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - 付费类型，可选值如下: Year: 按年付费 Month: 按月付费 Dynamic: 按需付费(单位: 小时) Trial: 免费试用默认值为: Dynamic
DataNodeSlaveCount (int) - 每个数据节点的只读实例个数, 取值必须>=0. 默认取值为0.
InstanceMode (str) - 存储节点的高可用模式，分为高可用UDB（HA）和普通UDB（Normal），如果不填，则默认为HA
InstanceType (str) - 存储节点和只读实例的磁盘类型。分为：SSD磁盘（SATA_SSD）或普通磁盘(Normal)。如果不填，则默认为SATA_SSD
Quantity (int) - 购买时长，默认值1

Response

Message (str) - 如果执行失败, 失败的错误消息
PriceInfo (dict) - 见 PriceDetailInfo 模型定义

Response Model

PriceDetailInfo - DataNodePrice (float) - 存储节点费用 - DataNodeSlavePrice (float) - 只读实例费用 - MiddlewarePrice (float) - 中间件路由节点费用

describe_uddb_instance_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUDDBInstanceUpgradePrice - 升级UDDB时，获取升级后的价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RouterNodeNum (int) - (Required) 其他版本：该参数可不填；专享版：物理机节点的个数。一台物理机有2个节点
RouterVersion (str) - (Required) UDDB路由节点的版本。分为三种： Trival(免费版)： 2中间件节点； QPS：1.5WFeelFree(标准版)：固定为4中间件节点，后续将根据业务请求量自动扩展，最多扩展到12个节点，QPS为3w - 10w；EnjoyAlone(物理机版)：专享物理机，节点数让客户可选
UDDBId (str) - (Required) UDDB实例ID
Zone (str) - (Required) 可用区。参见可用区列表
DataNodeCount (int) - 新的数据节点个数取值必须>0.
DataNodeDiskSpace (int) - 新的数据节点的磁盘大小配置. 单位: GB 具体数值参考UDB的磁盘大小取值.
DataNodeMemory (int) - 新的数据节点的内存配置, 单位：MB 具体数值参考UDB的内存取值.
DataNodeSlaveCount (int) - 每个数据节点的只读实例个数, 取值必须>=0.
InstanceMode (str) - 存储节点的高可用模式，分为高可用UDB（HA）和普通UDB（Normal），如果不填，则默认为HA
InstanceType (str) - 存储节点和只读实例的磁盘类型。分为：SSD磁盘（SATA_SSD）或普通磁盘(Normal)。如果不填，则默认为SATA_SSD

Response

Message (str) - 如果执行失败, 失败的错误消息
PriceInfo (dict) - 见 PriceInfo 模型定义

Response Model

PriceInfo - DataNodePrice (float) - 存储节点费用 - DataNodeSlavePrice (float) - 只读实例费用 - MiddlewarePrice (float) - 中间件路由节点费用

restart_uddb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

RestartUDDBInstance - 重启UDDB实例，开始提供服务。如下状态的UDDB实例可以进行这个操作:Running: 正常运行中Abnormal: 异常运行中当请求返回成功之后，UDDB实例的状态变成”Starting”(启动中); 如果返回失败, UDDB实例状态保持不变 UDDB实例在重启过程中, 当UDDB实例启动成功之后, UDDB实例的状态变成”Running”(正常运行中); 如果启动过程中出现异常, 状态变成”Abnormal”(异常运行中), 或者”Shutoff”(已关闭

Request

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

Response

Message (str) - 如果执行失败, 失败的错误消息

start_uddb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

StartUDDBInstance - 启动UDDB实例，开始提供服务。如下状态的UDDB实例可以进行这个操作:Shutoff: 已关闭当请求返回成功之后，UDDB实例的状态变成”Starting”(启动中); 如果返回失败, UDDB实例状态保持不变 UDDB实例在启动过程中, 当UDDB实例启动成功之后, UDDB实例的状态变成”Running”(正常运行中); 如果启动过程中出现异常, 状态变成”Abnormal”(异常运行中), 或者”Shutoff”(已关闭)

Request

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

Response

Message (str) - 如果执行失败, 失败的错误消息

stop_uddb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

StopUDDBInstance - 关闭UDDB实例，停止提供服务。如下状态的UDDB实例可以进行这个操作:Running: 正常运行中Abnormal: 异常运行中当请求返回成功之后，UDDB实例的状态变成”Shutdown”(关闭中); 如果返回失败, UDDB实例状态保持不变 UDDB实例在关闭过程中, 当UDDB实例关闭成功之后, UDDB实例的状态变成”Shutoff”(已关闭); 如果关闭过程中出现异常, 根据UDDB实例的情况, 状态变成”Abnormal”(异常运行中), 或者”Running”(正常运行中)

Request

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

Response

Message (str) - 如果执行失败, 失败的错误消息

upgrade_uddb_data_node(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpgradeUDDBDataNode - 升降级分布式数据库数据节点的配置, 提高/降低数据节点的数据容量和内存所有数据节点以及其所挂载的只读实例的配置都受到影响升降级数据节点的配置之后之后, 会按照数据节点新的磁盘和内存大小重新计费如下状态的数据节点实例可以进行这个操作:Shutoff: 已关闭当请求返回成功之后，UDDB实例的状态变成”UpgradingDataNode”，相关数据节点的状态变成”Upgrading”; 如果返回失败, UDDB实例状态保持不变当UDDB实例升级结束之后, UDDB实例的状态变成”Shutoff”

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DataNodeDiskSpace (int) - (Required) 新的数据节点的磁盘大小配置. 单位: GB 具体数值参考UDB的磁盘大小取值.
DataNodeMemory (int) - (Required) 新的数据节点的内存配置, 单位：MB 具体数值参考UDB的内存取值
UDDBId (str) - (Required) UDDB实例ID
CouponId (str) - 使用的代金券id
Zone (str) - 可用区。参见可用区列表

Response

Message (str) - 如果执行失败, 失败的错误消息

upgrade_uddb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpgradeUDDBInstance - 升降级分布式数据库中间件的配置, 提高/降低请求处理的并发性修改请求处理节点个数之后, 按照所有请求处理节点的总内存容量和CPU核数重新计费如下状态的UDDB实例可以进行这个操作:Running: 系统正常运行中当请求返回成功之后，UDDB实例的状态变成”UpgradingUDDB”; 如果返回失败, UDDB实例状态保持不变当UDDB实例升级成功之后, UDDB实例的状态变成”Running”; 如果更改过程中出现异常, 状态变成”Abnormal”, 或者”Error”

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RouterNodeNum (int) - (Required) 其他版本：该参数可不填；专享版：物理机台数
RouterVersion (str) - (Required) UDDB路由节点的版本。分为三种： Trival(免费版)： 2中间件节点； QPS：1.5W FellFree(标准版)：固定为4中间件节点，后续将根据业务请求量自动扩展，最多扩展到12个节点，QPS为3w - 10w； EnjoyAlone(物理机版)：专享物理机，节点数让客户可选
UDDBId (str) - (Required) UDDB实例ID
CouponId (str) - 使用的代金券id
Zone (str) - 可用区。参见可用区列表

Response

Message (str) - 如果执行失败, 失败的错误消息

UDTS¶

class ucloud.services.udts.client.UDTSClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

check_udts_task(req: Optional[dict] = None, **kwargs) → dict[source]¶

CheckUDTSTask - 对UDTS 任务提供预检查功能

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
MaxRetryCount (str) - (Required) 重试次数，最大为 5。默认为0
Name (str) - (Required) task 名称，长度不能超过 128
Type (str) - (Required) 任务类型，值为 transfer 或 integration， transfer 时任务为数据迁移，integration 时任务为数据集成。
Query (str) - 废弃
Source (list) - 见 CheckUDTSTaskParamSource 模型定义
Target (dict) - 见 CheckUDTSTaskParamTarget 模型定义

Response

Action (str) - 操作名称
Data (dict) - 见 CheckUDTSTaskResult 模型定义
Message (str) - 返回消息
RetCode (str) - 返回码

Request Model

CheckUDTSTaskParamSourceMySQLNodeSyncData - BinlogGTID (str) - 增量时需要指定的 binlog gtid，可以通过 show master status 获取，或者全量+增量任务会自动设置 - BinlogName (str) - 增量时需要指定的 binlog name，可以通过 show master status 获取，或者全量+增量任务会自动设置 - BinlogPos (int) - 增量时需要指定的 binlog pos，可以通过 show master status 获取，或者全量+增量任务会自动设置 - ServerID (int) - 增量时需要指定的 serverID，不能和现有的 slave 重复，预检查时会检查该值

CheckUDTSTaskParamSourceMySQLNodeQueryData - DBName (str) - 数据集成时需要迁移的 DB 名 - NewDBName (str) - 数据集成时迁移后的 DB 名

CheckUDTSTaskParamTargetMySQLNode - DataRegion (str) - 目标数据库地域，比如 cn-bj2 - Host (str) - 目标数据库地址，比如 10.9.37.212 - Password (str) - 目标数据库密码 - Port (int) - 目标数据库端口，比如 3306 - SubnetId (str) - 目标数据库子网 ID ,比如 subnet-zl44fktq - User (str) - 目标数据库用户名，比如 root - VPCId (str) - 目标数据库 VPC,比如 uvnet-1wz5rqte

CheckUDTSTaskParamSourceMySQLNode - DataRegion (str) - 数据库地域，比如 cn-bj2 - Database (str) - 需要迁移的 DB 名称 - Host (str) - 源数据库地址，比如 10.9.37.200 - Password (str) - 源 MySQL 密码 - Port (int) - 源 MySQL 端口，如 3306 - QueryData (list) - 见 CheckUDTSTaskParamSourceMySQLNodeQueryData 模型定义 - SubnetId (str) - 子网 ID - SyncData (dict) - 见 CheckUDTSTaskParamSourceMySQLNodeSyncData 模型定义 - Table (str) - 需要迁移的 table 名 - User (str) - 源 MySQL 用户名，如 root - VPCId (str) - VPC

CheckUDTSTaskParamTarget - DataType (str) - 目标数据库类型，比如 mysql - MySQLNode (dict) - 见 CheckUDTSTaskParamTargetMySQLNode 模型定义 - NWType (str) - 目标 db 网络类型，目前进支持 user

CheckUDTSTaskParamSource - DataType (str) - 数据库类型 - Mode (str) - // 任务类型，值可以是 full, incremental, full+incremental, bidirectional - MySQLNode (dict) - 见 CheckUDTSTaskParamSourceMySQLNode 模型定义 - NWType (str) - 源网络类型，可以是 public,user,dedicated_line

Response Model

CheckResultItem - ErrMessage (str) - - State (str) - 状态

CheckResult - Config (dict) - 见 CheckResultItem 模型定义 - Connection (dict) - 见 CheckResultItem 模型定义 - Privileges (dict) - 见 CheckResultItem 模型定义

CheckUDTSTaskResult - Source (dict) - 见 CheckResult 模型定义 - Target (dict) - 见 CheckResult 模型定义

create_udts_task(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUDTSTask - 创建UDTS任务

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Name (str) - (Required) task 名称，长度不能超过 128
Type (str) - (Required) 任务类型，transfer(数据传输) 或 integration(数据集成)
IsUnidirection (str) - 暂时未使用该字段
MaxRetryCount (str) - 重试次数，最大为 5。默认为0
Query (str) - 暂时未使用该字段
Remark (str) - 备注信息，长度不能大于 255
Source (list) - 见 CreateUDTSTaskParamSource 模型定义
Target (dict) - 见 CreateUDTSTaskParamTarget 模型定义

Response

Data (dict) -
Message (str) - 返回消息

Request Model

CreateUDTSTaskParamSourceMySQLNodeQueryDataTableData - ExcludeTables (bool) - 暂时未使用该字段 - TableNames (str) - 暂时未使用该字段

CreateUDTSTaskParamSourceMySQLNodeQueryDataTableMaps - NewTableName (str) - 数据集成时迁移后的 Table 名 - TableName (str) - 数据集成时需要迁移的 Table 名

CreateUDTSTaskParamSourceMySQLNodeSyncData - BinlogGTID (str) - 增量时需要指定的 binlog gtid，可以通过 show master status 获取，或者全量+增量任务会自动设置 - BinlogName (str) - 增量时需要指定的 binlog name，可以通过 show master status 获取，或者全量+增量任务会自动设置 - BinlogPos (int) - 增量时需要指定的 binlog pos，可以通过 show master status 获取，或者全量+增量任务会自动设置 - ServerID (int) - 增量时需要指定的 serverID，不能和现有的 slave 重复，预检查时会检查该值

CreateUDTSTaskParamSourceMySQLNodeQueryData - DBName (str) - 数据集成时需要迁移的 DB 名 - NewDBName (str) - 数据集成时迁移后的 DB 名 - TableData (dict) - 见 CreateUDTSTaskParamSourceMySQLNodeQueryDataTableData 模型定义 - TableMaps (list) - 见 CreateUDTSTaskParamSourceMySQLNodeQueryDataTableMaps 模型定义

CreateUDTSTaskParamSourceMySQLNode - DataRegion (str) - 数据库地域，比如 cn-bj2 - Database (str) - 需要迁移的 DB 名称 - DupAction (str) - 重复数据处理规则，数据集成时该参数才有效，值为 ignore或者replace - Host (str) - 源数据库地址 - KeepExistData (bool) - 是否保留原有数据，只有数据集成时该参数才有效 - Password (str) - 源数据库密码 - Port (int) - 源数据库端口 - QueryData (list) - 见 CreateUDTSTaskParamSourceMySQLNodeQueryData 模型定义 - SubnetId (str) - 源数据库子网 ID，当网络类型为 user 时需要填写 - SyncData (dict) - 见 CreateUDTSTaskParamSourceMySQLNodeSyncData 模型定义 - Table (str) - 需要迁移的 table 名 - User (str) - 源数据库用户名 - VPCId (str) - 源数据库 VPC ID，当网络类型为 user 时需要填写

CreateUDTSTaskParamTargetMySQLNode - DataRegion (str) - 目标数据库地域，比如 cn-bj2 - Host (str) - 目标数据库地址，比如 10.9.37.212 - NoBinlog (bool) - 是否在全量过程中，临时禁用目标 MySQL 产生 binlog，在目标磁盘空间不足，或者需要获取更快的迁移速度时可以使用，该参数会破坏目标 MySQL 的高可用 - Password (str) - 目标数据库密码 - Port (int) - 目标数据库端口，比如 3306 - SubnetId (str) - 目标数据库子网 ID ,比如 subnet-zl44fktq - User (str) - 目标数据库用户名，比如 root - VPCId (str) - 目标数据库 VPC,比如 uvnet-1wz5rqte

CreateUDTSTaskParamSource - BandwidthLimit (int) - 源端限速值，单位为 MB/s - DataType (str) - 数据库类型，比如 mysql - Mode (str) - 任务类型，值可以是 full, incremental, full+incremental, bidirectional - MySQLNode (dict) - 见 CreateUDTSTaskParamSourceMySQLNode 模型定义 - NWType (str) - 源网络类型，可以是 public,user,dedicated_line

CreateUDTSTaskParamTarget - BandwidthLimit (str) - 目标端限速，单位为 MB/s - DataType (str) - 目标数据库类型，比如 mysql - Mode (str) - - MySQLNode (dict) - 见 CreateUDTSTaskParamTargetMySQLNode 模型定义 - NWType (str) - 目标 db 网络类型，目前仅支持 user

get_udts_task_history(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUDTSTaskHistory - 获取任务历史状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
TaskId (str) - (Required) 任务短 id
Type (str) - 任务类型

Response

Data (list) - 见 TaskHistoryItem 模型定义

Response Model

TaskHistoryItem - AntID (str) - 任务 ID - AntState (str) - 任务状态 - CreateTime (int) - 事件时间，值为 timestamp - CreateTimeH (str) - 事件时间，为可读的日期时间

get_udts_task_status(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUDTSTaskStatus - 查看服务状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
TaskId (str) - (Required) 任务ID
Type (str) - 任务类型，值为 transfer 或 integration， transfer 时任务为数据迁移，integration 时任务为数据集成。

Response

Data (dict) - 见 StatusData 模型定义
Message (str) - 返回信息

Response Model

SyncData - BinlogGTID (str) - GTID - BinlogName (str) - Binlog 文件名，长度不超过128字符 - BinlogPos (int) - Binlog Pos - ServerId (int) - 分配给UDTS task的server ID, 必须在MySQL集群中唯一

Progress - CurCount (int) - 已迁移条目数 - CurDuration (int) - 已耗时间（单位秒） - Percentage (float) - 完成进度 - TotalCount (int) - 总条目数 - TotalDuration (int) - 估算总耗时间（单位秒）

StatusData - CurRetryCount (int) - 当前失败重试次数 - FailedMessage (str) - 当Status为Failed时, 显示失败原因 - MaxRetryCount (int) - 用户设置的最大失败重试次数 - Progress (dict) - 见 Progress 模型定义 - Status (str) - 任务状态, 状态有 Created:已创建,Checking:检查中,Dumping:转储中,Loading:加载中,Syncing:同步中,Synced:已同步,Done:完成,Failed:失败,Stopping:停止中,Stopped:停止,RetryPending:重试等待中,Starting:启动中,FailedUnrecoverable:异常,StoppedUnrecoverable:异常,Success:成功,Started:已启动 - Sync (dict) - 见 SyncData 模型定义

list_udts_task(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListUDTSTask - 获取用户创建的 Task 信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Limit (str) - 请求数量，默认为 20
Offset (str) - 偏移量，默认为 0
Type (str) - 任务类型

Response

Data (list) - 见 ListDataItem 模型定义
Message (str) - 返回信息

Response Model

Progress - CurCount (int) - 已迁移条目数 - CurDuration (int) - 已耗时间（单位秒） - Percentage (float) - 完成进度 - TotalCount (int) - 总条目数 - TotalDuration (int) - 估算总耗时间（单位秒）

ListDataItem - CreateTime (int) - 创建时间 - CurRetryCount (int) - 当前失败重试次数 - MaxRetryCount (int) - 最大失败重试次数 - Name (str) - 任务名称 - Progress (dict) - 见 Progress 模型定义 - Status (str) - 任务状态 - TaskId (str) - 任务 ID - Type (str) - 任务类型, full全量, incremental增量，full+incremental全量+增量。

start_udts_task(req: Optional[dict] = None, **kwargs) → dict[source]¶

StartUDTSTask - 启动UDTS服务

Request

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

Response

Message (str) - 返回信息

stop_udts_task(req: Optional[dict] = None, **kwargs) → dict[source]¶

StopUDTSTask - 停止UDTS任务

Request

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

Response

Message (str) - 返回信息

UEC¶

class ucloud.services.uec.client.UECClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

bind_u_ec_firewall(req: Optional[dict] = None, **kwargs) → dict[source]¶

BindUEcFirewall - 绑定防火墙，应用防火墙规则

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
FirewallId (str) - (Required) 防火墙Id
ResourceId (str) - (Required) 虚拟机资源Id或容器组资源id

Response

create_u_ec_custom_image(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUEcCustomImage - 从指定虚拟机，生成自定义镜像。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ImageName (str) - (Required) 镜像名称
NodeId (str) - (Required) 虚拟机实例ID
ImageDescription (str) - 镜像描述

Response

ImageId (str) - 镜像ID

create_u_ec_firewall(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUEcFirewall - 创建外网防火墙

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Name (str) - (Required) 防火墙名称
Remark (str) - 描述
Rule (list) - 见 CreateUEcFirewallParamRule 模型定义

Response

FirewallId (str) - 防火墙Id

Request Model

CreateUEcFirewallParamRule - Action (str) - ACCEPT（接受）和DROP（拒绝） - Port (str) - 端口，范围用”-“符号分隔，如：1-65535 - Priority (str) - 优先级：HIGH（高），MEDIUM（中），LOW（低） - ProtocolType (str) - 协议，可选值：TCP，UDP，ICMP - Remark (str) - 备注 - SrcIp (str) - 源ip

create_u_ec_holder(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUEcHolder - 创建容器组

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
CpuCore (float) - (Required) 容器组Cpu总核数
IdcId (str) - (Required) 机房id
MemSize (int) - (Required) 容器组总内存，单位MB
SubnetId (str) - (Required) 子网ID
Bandwidth (int) - 外网绑定的带宽（单位M，默认0，只有当ElasticIp为yes时，默认1）
ChargeQuantity (int) - 月数或者年数（默认值：1，当为按月计费时，0表示计费到月底，默认值为0）
ChargeType (int) - 付费方式（2按月、3按年。默认2，默认月付）
ElasticIp (str) - 绑定外网ip（yes-绑定，no-不绑定，默认no）
FirewallId (str) - 防火墙ID
Image (list) - 见 CreateUEcHolderParamImage 模型定义
Name (str) - 容器组名称（默认default）
Pack (list) - 见 CreateUEcHolderParamPack 模型定义
ProductType (str) - 机型（normal-经济型，hf-标准型，默认normal）
RestartStrategy (int) - 重启策略（0总是，1失败是，2永不，默认0）
Storage (list) - 见 CreateUEcHolderParamStorage 模型定义

Response

ResourceId (str) - 容器组资源id

Request Model

CreateUEcHolderParamImage - Message (str) - 镜像用户名和密码（如镜像名：密码） - StoreAddress (str) - 镜像仓库地址

CreateUEcHolderParamPack - Args (str) - 容器参数（多个用；隔开） - Cmd (str) - 开启容器的命令 - ConfigDict (str) - 容器配置字典（多个用；隔开，如：/data1:resId1;/data2:resId2） - CpuCore (float) - 容器Cpu核数 - Environment (str) - 容器环境变量（多个用；隔开,如：key1:value1;key2:value2） - ImageName (str) - 容器镜像名称 - MemSize (int) - 容器内存，单位MB - Name (str) - 容器名称 - WorkDir (str) - 容器工作目录

CreateUEcHolderParamStorage - Path (str) - 存储卷挂载路径 - ResourceId (str) - 存储卷资源id

create_u_ec_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUEcSubnet - 创建子网

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
CIDR (str) - (Required) 子网cidr
IdcId (str) - (Required) 机房ID
Comment (str) - 备注
SubnetName (str) - 子网名称

Response

SubnetId (str) - 子网ID

create_u_ec_v_host(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUEcVHost - 创建虚拟机v2.0

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
CpuCore (int) - (Required) cpu核心数
DiskSize (int) - (Required) 数据盘大小，单位GB
IdcId (str) - (Required) 机房id
ImageId (str) - (Required) 镜像ID
MemSize (int) - (Required) 内存大小，单位GB
NetLimit (int) - (Required) 节点带宽限制，单位Mbs
AccountName (str) - 账户名，默认root
ChargeQuantity (int) - 月数或者年数，0计费到月底，默认0
ChargeType (int) - 付费方式，1按时，2按月，3按年，默认2
FirewallId (str) - 外网防护墙规则组，默认
Gpu (int) - Gpu卡核心数。仅Gpu机型支持此字段
GpuType (str) - Gpu类型，枚举值[“T4S”],ProductType为G时必填
IsNeedOuterIp (str) - 是否需要外网ip（no-否）
Isp (list) - 运营商（1-电信，2-联通，4移动）
NodeCount (int) - 创建节点数量，默认1
NodeName (str) - 节点名称
PassWord (str) - 密码
ProductType (str) - 产品类型：normal（经济型），hf（标准型）,g(Gpu型)
SubnetId (str) - 子网ID
SysDiskSize (int) - 系统盘大小，单位GB，默认20GB

Response

NodeList (list) - 见 NodeList 模型定义

Response Model

NodeList - NodeId (str) - 虚拟机资源id

delete_u_ec_custom_image(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUEcCustomImage - 删除UEDN客户自定义镜像

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ImageId (str) - (Required) 镜像ID
IdcId (str) - 机房ID，带机房ID表示只删除指定机房镜像

Response

ImageId (int) - 镜像ID

delete_u_ec_holder(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUEcHolder - 删除容器组

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
HolderId (list) - (Required) 容器组资源id，n为0，1，2…

Response

delete_u_ec_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUEcSubnet - 删除子网

Request

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

Response

delete_u_ec_v_host(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUEcVHost - 删除vhost虚拟机 v2.0

Request

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

Response

describe_u_ec_firewall(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUEcFirewall - 获取防火墙信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
FirewallId (str) - 防火墙ID，默认为返回所有防火墙
Limit (int) - 返回数据长度，默认为20
Offset (int) - 列表起始位置偏移量，默认为0
ResourceId (str) - 绑定防火墙组的虚拟机资源ID

Response

FirewallSet (list) - 见 FirewallInfo 模型定义
TotalCount (int) - 满足条件的节点总数

Response Model

FirewallInfo - CreateTime (int) - 创建时间 - FirewallId (str) - 防火墙Id - Name (str) - 防火墙名称 - Remark (str) - 描述 - ResourceCount (int) - 防火墙绑定资源数量 - Rule (list) - 见 RuleInfo 模型定义 - Type (str) - 防火墙组类型，枚举值为： “user defined”, 用户自定义防火墙； “recommend web”, 默认Web防火墙； “recommend non web”, 默认非Web防火墙

RuleInfo - Action (str) - ACCEPT（接受）和DROP（拒绝） - Port (str) - 端口，范围用”-“符号分隔，如：1-65535 - Priority (str) - 优先级：HIGH（高），MEDIUM（中），LOW（低） - ProtocolType (str) - 协议，可选值：TCP，UDP，ICMP - Remark (str) - 备注 - SrcIp (str) - 源ip

describe_u_ec_firewall_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUEcFirewallResource - 防火墙绑定的资源列表

Request

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

Response

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

Response Model

ResourceInfo - Name (str) - 节点名称 - PublicIpList (list) - 节点公网Ip列表 - Remark (str) - 节点备注 - ResourceId (str) - 资源Id - State (int) - 节点状态，1部署中，2待启动，3启动中，4运行中，5正在停止，6已停止，7正在更新，8正在重启，9正在删除， 10已经删除,11异常

describe_u_ec_holder(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUEcHolder - 获得容器组信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
HolderId (list) - 容器组资源id
Limit (int) - 返回数据长度，默认为20，非负整数
Offset (int) - 列表起始位置偏移量，默认为0。非负整数

Response

HolderList (list) - 见 HolderList 模型定义
TotalCount (int) - 满足条件的容器组总数

Response Model

HolderList - City (str) - 城市名称 - CreateTime (int) - 创建时间 - DockerCount (int) - 容器数量 - DockerInfo (list) - 见 DockerInfo 模型定义 - ExpireTime (int) - 过期时间 - FirewallId (str) - 外网防火墙id - HolderName (str) - 容器组名称 - IdcId (str) - 机房id - ImageList (list) - 见 ImageList 模型定义 - InnerIp (str) - 容器组内网ip - IpList (list) - 见 IpList 模型定义 - NetLimit (int) - 外网绑定的带宽 - OcName (str) - 机房名称 - ProductType (str) - 机器类型（normal经济型，hf标准型） - Province (str) - 省份名称 - ResourceId (str) - 容器组资源id - RestartStrategy (int) - 0：总是；1：失败是；2：永不 - State (int) - 容器组运行状态0：初始化；1：拉取镜像；2：启动中；3：运行中；4：错误；5：正在重启；6：正在删除；7：已经删除；8：容器运行错误；9：启动失败；99：异常 - StorVolumeCount (int) - 存储卷数量 - StorVolumeInfo (list) - 见 StorVolumeInfo 模型定义 - SubnetId (str) - 容器组子网id - Type (int) - 线路类型（运营商类型： 0-其它, 1-一线城市单线,2-二线城市单线, 3-全国教育网, 4-全国三通）

DockerInfo - Args (str) - 参数 - CfgDictList (list) - 见 CfgDictList 模型定义 - Command (str) - 命令 - CpuCores (float) - CPU核数（/核）精度0.1核 - EnvList (list) - 见 EnvList 模型定义 - ImageName (str) - 镜像名称 - MemSize (float) - 内存大小（Gi） - Name (str) - 容器名称 - State (int) - 容器状态，0：初始化；1：拉取镜像；2：拉取镜像失败；3：启动中；4：运行中；5：正在停止；6：已停止；7：已删除；8：镜像拉取成功；9：启动失败；99：异常 - WorkDir (str) - 工作目录

CfgDictList - MountPath (str) - 挂载路径 - Name (str) - 名称 - ResourceId (str) - 资源id

EnvList - Key (str) - 环境变量key值 - Value (str) - 环境变量Value值

ImageList - ImageKey (str) - 镜像密钥 - StoreAddr (str) - 仓库地址 - UserName (str) - 用户名称

IpList - Ip (str) - 外网ip - Isp (str) - 运营商

StorVolumeInfo - DiskSize (int) - 容量（单位GB） - MountPoint (str) - 挂载点 - Name (str) - 名称 - ResourceId (str) - 资源id

describe_u_ec_holder_idc(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUEcHolderIDC - 获取容器组机房信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Cpu (float) - (Required) 容器组Cpu核数
Memory (int) - (Required) 容器组内存大小（单位MB）
IdcId (list) - Idc机房id。默认全部机房
ProductType (str) - 产品类型，normal标准型，hf高性能型
Type (int) - 0-其它, 1-一线城市单线,2-二线城市单线, 3-全国教育网, 4-全国三通

Response

IdcList (list) - 见 IdcInfo 模型定义

Response Model

IdcInfo - City (str) - 城市 - IdcId (str) - 机房ID - Isp (str) - 运营商 - MaxNodeCnt (int) - 机房可创建节点最大数量 - Name (str) - 机房名称 - Province (str) - 省份 - Type (int) - 运营商类型：0-其它, 1-一线城市单线,2-二线城市单线, 3-全国教育网, 4-全国三通

describe_u_ec_idc(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUEcIDC - 获取IDC机房列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Cpu (int) - (Required) 节点cpu核数
Memory (int) - (Required) 节点内存大小，单位GB
Gpu (int) - Gpu卡核心数
IdcId (list) - Idc机房id。默认全部机房
ProductType (str) - 产品类型：normal（经济型），hf（标准型）,g(GPU型)
Type (int) - 0-其它, 1-一线城市单线,2-二线城市单线, 3-全国教育网, 4-全国三通

Response

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

Response Model

IdcInfo - City (str) - 城市 - IdcId (str) - 机房ID - Isp (str) - 运营商 - MaxNodeCnt (int) - 机房可创建节点最大数量 - Name (str) - 机房名称 - Province (str) - 省份 - Type (int) - 运营商类型：0-其它, 1-一线城市单线,2-二线城市单线, 3-全国教育网, 4-全国三通

describe_u_ec_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUEcSubnet - 获取子网列表

Request

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

Response

SubnetList (list) - 见 SubnetInfo 模型定义

Response Model

SubnetInfo - AvailableIPCnt (int) - 可用ip数 - CIDR (str) - 子网cidr - Comment (str) - 备注 - CreateTime (int) - 创建时间 - IdcId (str) - 机房ID - SubnetId (str) - 子网ID - SubnetName (str) - 子网名称 - TotalIpCnt (int) - 总ip数

describe_u_ec_v_host(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUEcVHost - 获取虚拟机列表 2.0

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
IdcId (list) - Idc机房id。默认全部机房
Limit (int) - 返回数据长度，默认20，非负整数
NodeId (list) - 节点id，创建节点时生成的id。默认全部节点
Offset (int) - 数据偏移量，默认0，非负整数

Response

NodeList (list) - 见 NodeInfo 模型定义
TotalCount (int) - 满足条件的节点总数

Response Model

NodeInfo - ChargeType (int) - 付费类型：1按时, 2按月,3按年 - City (str) - 城市 - CoreNum (int) - Cpu核数 - CreateTime (int) - 创建时间 - DiskSize (int) - 数据盘大小，单位GB - ExpiredTime (int) - 过期时间 - FirewallId (str) - 防火墙Id - IdcId (str) - 机房ID - ImageName (str) - 镜像名称 - InnerIps (list) - 内网ip列表 - MemSize (int) - 节点内存大小，单位GB - NetLimit (int) - 节点带宽限制，单位Mbs - NodeId (str) - 节点ID - NodeIpList (list) - 见 NodeIpList 模型定义 - NodeName (str) - 节点名称 - OcName (str) - 机房名称 - ProductType (str) - 机器类型(normal-经济型,hf-标准型,g-GPU型) - Province (str) - 省份 - State (int) - 节点状态，1部署中，2待启动，3启动中，4运行中，5正在停止，6已停止，7正在更新，8正在重启，9正在删除， 10已经删除,11异常 - SysDiskSize (int) - 系统盘大小，单位GB - Type (int) - 运营商类型： 0-其它, 1-一线城市单线,2-二线城市单线, 3-全国教育网, 4-全国三通

NodeIpList - Ip (str) - 外网ip - Isp (str) - 运营商 - IspName (str) - 运营商名称

describe_u_ec_v_host_isp(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUEcVHostISP - 获取虚拟机运营商信息

Request

City (str) - 城市
IspName (str) - 运营商名称
Province (str) - 省份

Response

NodeIspList (list) - 见 NodeIspList 模型定义

Response Model

NodeIspList - City (str) - 城市 - IdcName (str) - 机房名称 - IspName (str) - 机房运营商名称 - LineType (str) - 线路类型 - Province (str) - 省份

get_u_ec_holder_log(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUEcHolderLog - 获取单个容器日志

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
PackName (str) - (Required) 容器名称
ResourceId (str) - (Required) 容器组资源id

Response

Data (str) - 返回的日志数据

get_u_ec_holder_metrics(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUEcHolderMetrics - 获取容器（CPU利用率，带宽，内存）数据

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
PackName (str) - (Required) 容器名称
ResourceId (str) - (Required) 容器组资源id
Type (list) - (Required) n为0 CPU利用率, 1内存使用率, 2网卡出带宽, 3网卡入带宽, 4网卡出包数, 5网卡入包数
EndTime (int) - 结束时间
StartTime (int) - 开始时间

Response

DataSets (dict) - 见 MetricisDataSet 模型定义

Response Model

MetricisDataSet - CPUUtilization (list) - 见 MonitorInfo 模型定义 - MemUtilization (list) - 见 MonitorInfo 模型定义 - NICIn (list) - 见 MonitorInfo 模型定义 - NICOut (list) - 见 MonitorInfo 模型定义 - NetPacketIn (list) - 见 MonitorInfo 模型定义 - NetPacketOut (list) - 见 MonitorInfo 模型定义

MonitorInfo - TimeStamp (int) - 时间戳 - Value (int) - 值

get_u_ec_idc_cut_info(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUEcIDCCutInfo - 获取机房割接信息

Request

Response

IDCCutInfo (list) - 见 IDCCutInfo 模型定义
TotalCount (int) - 满足条件的机房总数

Response Model

IDCCutInfo - City (str) - 城市 - CutType (str) - 割接类型（中断、抖动、断电） - EndTime (int) - 割接结束时间 - IDCName (str) - 机房名称 - Province (str) - 省份 - ResourceSet (list) - 见 ResourceSet 模型定义 - StartTime (int) - 割接开始时间

ResourceSet - NodeId (str) - 节点id - OuterIps (list) - 机器外网ip集合

get_u_ec_idcv_host_data(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUEcIDCVHostData - 获取机房虚拟机监控数据

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
NodeId (list) - (Required) 节点资源id；n为0，1，2…
Type (list) - (Required) 监控数据类型；n为0,1,2,3,4…,9
BeginTime (int) - 开始时间戳
EndTime (int) - 结束时间戳

Response

DataSets (dict) - 见 DataSet 模型定义

Response Model

DataSet - CPUUtilization (list) - 见 MonitorInfo 模型定义 - DiskReadOps (list) - 见 MonitorInfo 模型定义 - DiskWriteOps (list) - 见 MonitorInfo 模型定义 - IORead (list) - 见 MonitorInfo 模型定义 - IOWrite (list) - 见 MonitorInfo 模型定义 - MemUtilization (list) - 见 MonitorInfo 模型定义 - NICIn (list) - 见 MonitorInfo 模型定义 - NICOut (list) - 见 MonitorInfo 模型定义 - NetPacketIn (list) - 见 MonitorInfo 模型定义 - NetPacketOut (list) - 见 MonitorInfo 模型定义

MonitorInfo - TimeStamp (int) - 时间戳 - Value (int) - 值

get_u_ec_image(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUEcImage - uec2.0

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ImageType (str) - 镜像类型：1标准镜像，2行业镜像，3自定义镜像
Limit (int) - 返回数据长度，默认20，非负整数
Offset (int) - 数据偏移量，默认0，非负整数

Response

ImageList (list) - 见 ImageInfo 模型定义
TotalCount (int) - 镜像总数

Response Model

ImageInfo - CreateTime (int) - 镜像创建时间戳 - DeployInfoList (list) - 见 DeployImageInfo 模型定义 - Gpu (int) - 是否支持Gpu(1-支持,0-不支持) - ImageDesc (str) - 镜像描述 - ImageId (str) - 镜像ID - ImageName (str) - 镜像名称 - ImageSize (int) - 镜像大小，单位GB - ImageType (int) - 镜像类型：1标准镜像，2行业镜像，3自定义镜像 - OcType (str) - 系统类型：unix, windows - State (int) - 镜像状态：镜像状态 1可用，2不可用，3制作中

DeployImageInfo - IdcId (str) - 机房ID - State (int) - 镜像状态 1-可用, 2-不可用, 3-获取中, 4-转换中, 5-部署中

get_u_ec_pod_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUEcPodPrice - 获得容器组价格

Request

IdcId (str) - (Required) 机房id
Bandwidth (int) - 绑定的带宽，默认0，当绑定外网IP时默认1（单位M）
ChargeQuantity (int) - 月数或年数（默认值：1，当支付类型为按月时，默认值为0）
ChargeType (int) - 支付类型（2按月，3按年，默认2）
CpuCore (float) - 容器组总Cpu核心数
ElasticIp (str) - 是否绑定外网IP（yes：是，no：否，默认：no）
MemSize (int) - 容器组总内存大小（单位M）
ProductType (str) - 产品类型（normal：标准型，hf：高性能型，默认：normal）

Response

HolderPrice (float) - 容器组价格
IpPrice (float) - IP和带宽价格

get_u_ec_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUEcUpgradePrice - 获取虚拟机调整差价

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
NodeId (str) - (Required) 虚拟机资源ID
CpuCore (int) - cpu核心数
DiskSize (int) - 数据盘大小，单位GB
MemSize (int) - 内存大小，单位GB
NetLimit (int) - 节点带宽限制，单位Mbs
SysDiskSize (int) - 系统盘大小，单位GB

Response

Price (int) - 规格调整差价

get_u_ec_v_host_data(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUEcVHostData - 获取虚拟机监控数据

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
NodeId (str) - (Required) 节点id
Type (list) - (Required) 0CPU使用率, 1内存使用率, 2 网卡出流量, 3网卡入流量, 4网卡出包量, 5网卡入包量, 6磁盘读流量, 7磁盘写流量, 8磁盘读次数, 9磁盘写次数
BeginTime (int) - 查询起始时间
EndTime (int) - 查询结束时间

Response

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

Response Model

DataSet - CPUUtilization (list) - 见 MonitorInfo 模型定义 - DiskReadOps (list) - 见 MonitorInfo 模型定义 - DiskWriteOps (list) - 见 MonitorInfo 模型定义 - IORead (list) - 见 MonitorInfo 模型定义 - IOWrite (list) - 见 MonitorInfo 模型定义 - MemUtilization (list) - 见 MonitorInfo 模型定义 - NICIn (list) - 见 MonitorInfo 模型定义 - NICOut (list) - 见 MonitorInfo 模型定义 - NetPacketIn (list) - 见 MonitorInfo 模型定义 - NetPacketOut (list) - 见 MonitorInfo 模型定义

MonitorInfo - TimeStamp (int) - 时间戳 - Value (int) - 值

get_u_ec_v_host_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUEcVHostPrice - 获取虚拟机价格

Request

IdcId (str) - (Required) 机房Id
ChargeQuantity (int) - 月数或者年数，0计费到月底，默认0
ChargeType (int) - 付费方式，1按时，2按月，3按年，默认2
CpuCore (int) - CPU核数
DiskSize (int) - 数据盘大小，单位GB
Gpu (int) - Gpu卡核心数。仅Gpu机型支持此字段
GpuType (str) - Gpu类型，枚举值[“T4”],ProductType为g时必填
IpCount (int) - 外网IP的数量，默认1
MemSize (int) - 内存大小，单位GB
NetLimit (int) - 网络带宽限速，单位Mbs
NodeCount (int) - 节点数量，默认1
ProductType (str) - 产品类型：normal（经济型），hf（标准型），g(Gpu型),默认normal
SysDiskSize (int) - 系统盘大小，单位GB

Response

IpPrice (float) - Ip和带宽价格
NodePrice (float) - 节点价格

import_u_ec_custom_image(req: Optional[dict] = None, **kwargs) → dict[source]¶

ImportUEcCustomImage - 导入自定义镜像

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Format (str) - 镜像格式，可选RAW、qcow2，不带镜像ID时必填
IdcId (list) - 镜像需要导入机房，默认分发到所有机房
ImageDesc (str) - 镜像描述
ImageId (str) - 镜像Id，不传参表示新导入镜像，传参表示已有镜像分发到指定机房
ImageName (str) - 镜像名称，不带镜像ID时必填
OsType (str) - 操作系统平台，linux、windows(当前版本暂不支持windows)，不带镜像ID时必填
UFileUrl (str) - UFile镜像文件下载地址，不带镜像ID时必填

Response

ImageId (str) - 镜像Id

login_u_ec_docker(req: Optional[dict] = None, **kwargs) → dict[source]¶

LoginUEcDocker - 登录容器

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Name (str) - (Required) 容器名称
ResourceId (str) - (Required) 容器组资源id

Response

Link (str) - 登录地址
LinkPort (int) - 登录端口
SessionId (str) - 返回的token

modify_u_ec_bandwidth(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyUEcBandwidth - 修改节点带宽限制

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
NetLimit (str) - (Required) 节点带宽限制，单位Mbs
NodeId (str) - (Required) 节点Id

Response

modify_u_ec_holder_name(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyUEcHolderName - 修改容器组名称

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Name (str) - (Required) 容器组名称
ResourceId (str) - (Required) 容器组资源id

Response

modify_u_ec_image_name(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyUEcImageName - 修改镜像名称

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ImageId (str) - (Required) 镜像ID
ImageName (str) - (Required) 镜像名称
ImageDesc (str) - 镜像描述

Response

poweroff_u_ec_v_host(req: Optional[dict] = None, **kwargs) → dict[source]¶

PoweroffUEcVHost - 虚拟机断电

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
NodeId (list) - (Required) 虚拟机资源ID

Response

reinstall_u_ec_v_host(req: Optional[dict] = None, **kwargs) → dict[source]¶

ReinstallUEcVHost - 虚拟机重装系统

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ImageId (str) - (Required) 镜像ID
NodeId (str) - (Required) 虚拟机资源ID
KeepData (int) - 是否保留数据盘数据， 0-不保留，1-保留，默认为1
Password (str) - 节点密码
SysDiskSize (int) - 系统盘大小，单位GB

Response

restart_u_ec_holder(req: Optional[dict] = None, **kwargs) → dict[source]¶

RestartUEcHolder - 重启容器组

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ResourceId (list) - (Required) 容器组资源id，n为0，1，2…

Response

restart_u_ec_v_host(req: Optional[dict] = None, **kwargs) → dict[source]¶

RestartUEcVHost - 重启虚拟机v2.0

Request

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

Response

start_u_ec_v_host(req: Optional[dict] = None, **kwargs) → dict[source]¶

StartUEcVHost - 启动UEC虚拟机

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
NodeId (list) - (Required) 虚拟机资源ID

Response

stop_u_ec_v_host(req: Optional[dict] = None, **kwargs) → dict[source]¶

StopUEcVHost - 停止UEC虚拟机

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
NodeId (list) - (Required) 虚拟机资源ID

Response

un_bind_u_ec_firewall(req: Optional[dict] = None, **kwargs) → dict[source]¶

UnBindUEcFirewall - 解绑防火墙

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
FirewallId (str) - (Required) 防火墙Id
ResourceId (str) - (Required) 节点Id或容器组资源id

Response

update_u_ec_firewall(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateUEcFirewall - 更新防火墙信息，新增和删除规则

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
FirewallId (str) - (Required) 防火墙Id
Rule (list) - 见 UpdateUEcFirewallParamRule 模型定义

Response

Request Model

UpdateUEcFirewallParamRule - Action (str) - ACCEPT（接受）和DROP（拒绝） - Port (str) - 端口，范围用”-“符号分隔，如：1-65535 - Priority (str) - 优先级：HIGH（高），MEDIUM（中），LOW（低） - ProtocolType (str) - 协议，可选值：TCP，UDP，ICMP - Remark (str) - 备注 - SrcIp (str) - 源ip

update_u_ec_firewall_attribute(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateUEcFirewallAttribute - 更新防火墙名称及描述

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
FirewallId (str) - (Required) 防火墙Id
Name (str) - 防火墙名称
Remark (str) - 描述

Response

update_u_ec_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateUEcSubnet - 更新子网信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
SubnetId (str) - (Required) 子网ID
Comment (str) - 备注
SubnetName (str) - 子网名称

Response

UFS¶

class ucloud.services.ufs.client.UFSClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

create_ufs_volume(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

RemoveUFSVolume - 删除UFS文件系统

Request

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

Response

UFile¶

class ucloud.services.ufile.client.UFileClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

create_bucket(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateBucket - 创建Bucket

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BucketName (str) - (Required) 待创建Bucket的名称，具有全局唯一性
Type (str) - Bucket访问类型，public或private; 默认为private

Response

BucketId (str) - 已创建Bucket的ID
BucketName (str) - 已创建Bucket的名称

create_ufile_token(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUFileToken - 创建US3令牌

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
TokenName (str) - (Required) 令牌名称
AllowedBuckets (list) - 令牌允许操作的bucket，默认*表示全部
AllowedOps (list) - 令牌允许执行的操作，[ TOKEN_ALLOW_NONE , TOKEN_ALLOW_READ , TOKEN_ALLOW_WRITE , TOKEN_ALLOW_DELETE , TOKEN_ALLOW_LIST, TOKEN_ALLOW_IOP , TOKEN_ALLOW_DP ]。默认TOKEN_ALLOW_NONE
AllowedPrefixes (list) - 令牌允许操作的key前缀，默认*表示全部
ExpireTime (int) - Unix 时间戳，精确到秒，为令牌过期时间点。默认过期时间为一天（即当前Unix时间戳+86400）；注意：过期时间不能超过 4102416000

Response

TokenId (str) - 创建令牌的token_id

delete_bucket(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteBucket - 删除Bucket

Request

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

Response

BucketId (str) - Bucket的ID
BucketName (str) - Bucket的名称

delete_ufile_token(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUFileToken - 删除令牌

Request

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

Response

describe_bucket(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeBucket - 获取Bucket的描述信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 如果提供此参数，则获取相应地域下所有空间的空间名称(只返回空间名称信息)
BucketName (str) - 待获取Bucket的名称，若不提供，则获取所有Bucket
Limit (int) - 获取所有Bucket列表的限制数目，默认为20
Offset (int) - 获取所有Bucket列表的偏移数目，默认为0

Response

DataSet (list) - 见 UFileBucketSet 模型定义

Response Model

UFileBucketSet - Biz (str) - Bucket所属业务, general或vod或udb general: 普通业务； vod: 视频云业务; udb: 云数据库业务 - BucketId (str) - Bucket的ID - BucketName (str) - Bucket名称 - CdnDomainId (list) - 与Bucket关联的CND加速域名的ID列表 - CreateTime (int) - Bucket的创建时间 - Domain (dict) - 见 UFileDomainSet 模型定义 - HasUserDomain (int) - 是否存在自定义域名。0不存在，1存在，2错误 - ModifyTime (int) - Bucket的修改时间 - Region (str) - Bucket所属地域 - Tag (str) - 所属业务组 - Type (str) - Bucket访问类型

UFileDomainSet - Cdn (list) - UCDN加速域名 - CustomCdn (list) - 用户自定义CDN加速域名 - CustomSrc (list) - 用户自定义源站域名 - Src (list) - 源站域名

describe_ufile_token(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUFileToken - 获取令牌信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Display (int) - 0表示显示部分token信息；不传递和其他情况表示显示全部token信息
TokenId (str) - 令牌ID，只返回指定ID信息，否则拉取所有令牌
TokenName (str) - 令牌名称，只返回指定令牌名称信息，否则拉取所有令牌

Response

DataSet (list) - 见 UFileTokenSet 模型定义

Response Model

UFileTokenSet - AllowedBuckets (list) - 令牌允许操作的bucket - AllowedOps (list) - 令牌允许执行的操作，[ TOKEN_ALLOW_NONE , TOKEN_ALLOW_READ , TOKEN_ALLOW_WRITE , TOKEN_ALLOW_DELETE , TOKEN_ALLOW_LIST, TOKEN_ALLOW_IOP , TOKEN_ALLOW_DP ] - AllowedPrefixes (list) - 令牌允许操作的key前缀 - CreateTime (int) - 创建时间 - ExpireTime (int) - 令牌的超时时间点 - ModifyTime (int) - 修改时间 - PrivateKey (str) - 令牌私钥 - PublicKey (str) - 令牌公钥 - Region (str) - 所属地区 - TokenId (str) - 令牌ID - TokenName (str) - 令牌名称

get_ufile_daily_report(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUFileDailyReport - 查看日消费报表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EndTime (int) - (Required) 查询结束时间;unix时间戳,单位s
StartTime (int) - (Required) 查询开始时间;unix时间戳，单位s
BucketName (str) - 空间名称。此字段不为空，返回此Bucket日使用量；否则，返回这个项目的日使用量

Response

DataSet (list) - 见 UFileReportItem 模型定义

Response Model

UFileDailyReportItem - AcRestore (float) - 冷存激活量，即归档数据取回量；单位byte - AcStorage (float) - 冷存（归档）存储量；单位byte - ApiTimes (float) - API请求次数（次） - BusyFlow (float) - 忙时流量；单位byte；海外无此字段 - CdnFlow (float) - cdn回源流量;单位byte - Date (int) - 配额消费时间，unix时间戳（单位s），精确到日期 - Flow (float) - 下载流量：单位byte；国内无此字段 - IaGetSize (float) - 低频数据取回量；单位byte - IaStorage (float) - 低频存储量；单位byte - IdleFlow (float) - 闲时流量；单位byte；海外无此字段 - Storage (float) - 标准存储量；单位byte

UFileTotalReportItem - ApiTimes (float) - API请求次数（次） - BusyFlow (float) - 忙时流量；单位byte；海外无此字段 - CdnFlow (float) - cdn回源流量;单位byte - Flow (float) - 下载流量：单位byte；国内无此字段 - IdleFlow (float) - 闲时流量；单位byte；海外无此字段

UFileReportItem - Daily (list) - 见 UFileDailyReportItem 模型定义 - Total (list) - 见 UFileTotalReportItem 模型定义

get_ufile_quota(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUFileQuota - 查看配额状态

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
QuotaType (str) - (Required) 配额类型，取值为storage-volume, download-traffic或request-count

Response

LeftQuota (float) - 剩余的配额数值

get_ufile_quota_info(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUFileQuotaInfo - 获取配额信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
QuotaType (list) - (Required) 配额类型，取值为storage-volume, download-traffic或request-count

Response

DataSet (list) - 见 UFileQuotaDataSetItem 模型定义

Response Model

UFileQuotaDataSetItem - DownloadFlow (dict) - 见 UFileQuotaLeft 模型定义 - Owe (int) - 是否欠费：1表示欠费；0表示未欠费 - Region (str) - 可用地域 - RequestCnt (dict) - 见 UFileQuotaLeft 模型定义 - Storage (dict) - 见 UFileQuotaLeft 模型定义

UFileQuotaLeft - Left (float) - 配额剩余量

get_ufile_quota_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUFileQuotaPrice - 根据US3的购买配额，查询需要支付的价格。

Request

Region (str) - (Config) 地域。参见地域和可用区列表
DownloadTraffic (int) - 下载流量，单位: GB，范围: [0, 60 000]，步长：1GB
RequestCount (int) - 请求次数，单位：万次，范围：[0, 1 000 000]，步长：1万次
StorageVolume (int) - 存储容量，单位: GB*天，范围: [0, 30 000 000]，步长：100GB*天

Response

Price (float) - 待支付价格，单位：分

get_ufile_report(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetUFileReport - 查看配额使用报表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EndTime (int) - (Required) 查询结束时间
StartTime (int) - (Required) 查询开始时间

Response

DataSet (list) - 见 UFileReportSet 模型定义

Response Model

UFileReportSet - DownloadTraffic (float) - 配额消费当日使用的下载流量，单位：GB - RequestCount (float) - 配额消费当日使用的请求次数，单位：万次 - StorageVolume (float) - 配额消费当日使用的存储容量，单位：GB*天 - Time (int) - 配额消费时间，unix时间戳，精确到日期

set_ufile_referer(req: Optional[dict] = None, **kwargs) → dict[source]¶

SetUFileReferer - 设置对象存储防盗链

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BucketName (str) - (Required) 存储空间名称
RefererStatus (str) - (Required) 开启关闭referer防盗链;关闭防盗链会清空防盗链参数设置，开启防盗链必须指定 RefererType、Referers；开启：on，关闭：off;
RefererAllowNull (bool) - RefererType为白名单时，RefererAllowNull为false代表不允许空referer访问，为true代表允许空referer访问;此参数默认为 true;
RefererType (int) - 防盗链Referer类型，支持两种类型，黑名单和白名单; 1黑名单，2白名单；RefererStatus为”on”时此参数必填；
Referers (list) - 防盗链Referer规则，支持正则表达式（不支持符号’;’)

Response

update_bucket(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateBucket - 更改Bucket的属性

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
BucketName (str) - (Required) 待修改Bucket的名称
Type (str) - (Required) Bucket访问类型;public或private

Response

BucketId (str) - Bucket的ID
BucketName (str) - Bucket的名称

update_ufile_token(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateUFileToken - 更新令牌的操作权限，可操作key的前缀，可操作bucket和令牌超时时间点

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
TokenId (str) - (Required) 令牌ID
AllowedBuckets (list) - 令牌允许操作的bucket
AllowedOps (list) - 令牌允许执行的操作，[ TOKEN_ALLOW_NONE , TOKEN_ALLOW_READ , TOKEN_ALLOW_WRITE , TOKEN_ALLOW_DELETE , TOKEN_ALLOW_LIST, TOKEN_ALLOW_IOP , TOKEN_ALLOW_DP ]
AllowedPrefixes (list) - 令牌允许操作的key前缀
ExpireTime (int) - 令牌的超时时间点（时间戳）;注意：过期时间不能超过 4102416000
TokenName (str) - 令牌名称

Response

UHub¶

class ucloud.services.uhub.client.UHubClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

create_repo(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateRepo - 创建镜像仓库

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
RepoName (str) - (Required) 仓库名称，不可修改
Description (str) - 仓库备注
IsShared (bool) - 镜像仓库是否公开，公开为true、不公开为false;默认为false

Response

Message (str) - 有错误时返回内容

delete_repo(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteRepo - 删除镜像仓库

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
RepoName (str) - (Required) 镜像仓库名称

Response

delete_repo_image(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteRepoImage - 删除镜像

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
ImageName (str) - (Required) 镜像名称
RepoName (str) - (Required) 镜像仓库名称
TagName (str) - 不指定tag则删除全部tag

Response

get_image_tag(req: Optional[dict] = None, **kwargs) → dict[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 - Digest (str) - 镜像digest值 - TagName (str) - Tag名称 - UpdateTime (str) - 镜像更新时间

get_repo(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateRepo - 更新镜像仓库

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
RepoName (str) - (Required) 镜像仓库名称，不可修改
Description (str) - 备注
IsShared (str) - false设置为私有；true设置为公有。默认false

Response

Message (str) - 错误的时候返回

UK8S¶

class ucloud.services.uk8s.client.UK8SClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

add_uk8s_existing_uhost(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddUK8SExistingUHost - 将预先创建好的云主机加入到UK8S集群，需要注意的是，该云主机依然会执行重装系统的操作。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ClusterId (str) - (Required) UK8S集群ID。可从UK8S控制台获取。
Password (str) - (Required) Node节点密码。请遵照字段规范设定密码。密码需使用base64进行编码，如下：# echo -n Password1 | base64
UHostId (str) - (Required) 云主机Id，为了保证节点正常运行，该主机配置不得低于2C4G。
DisableSchedule (bool) - 用于标示添加完节点后是否将节点临时禁用. 传入 “true” 表示禁用,传入其它或不传表示不禁用
ImageId (str) - 镜像 Id，不填时后台程序会自动选用一个可用的镜像 Id，支持用户自定义镜像，自定义镜像必须基于基础镜像制作。
InitScript (str) - 用户自定义Shell脚本。与UserData的区别在于InitScript在节点初始化完毕后才执行，UserData则是云主机初始化时执行。
Labels (str) - Node节点标签。key=value形式,多组用”,“隔开，最多5组。如env=pro,type=game
MaxPods (int) - 默认110，生产环境建议小于等于110。
SubnetId (str) - 该云主机所属子网Id。
UserData (str) - 用户自定义数据。当镜像支持Cloud-init Feature时可填写此字段。注意：1、总数据量大小不超过 16K；2、使用base64编码。
Zone (str) - 可用区。参见可用区列表

Response

Message (str) - 返回错误消息，当 RetCode 非 0 时提供详细的描述信息。

add_uk8s_node_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddUK8SNodeGroup - 添加UK8S节点池

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ClusterId (str) - (Required) 集群ID
NodeGroupName (str) - (Required) 节点池名字
BootDiskType (str) - 磁盘类型
CPU (int) - GPU卡核心数。仅GPU机型支持此字段（可选范围与MachineType+GpuType相关）
ChargeType (str) - 计费模式
DataDiskSize (int) - 数据磁盘大小
DataDiskType (str) - 磁盘类型
GPU (int) - GPU卡核心数
GpuType (str) - GPU类型
ImageId (str) - 镜像ID
MachineType (str) - 云主机机型。枚举值[“N”, “C”, “G”, “O”, “OS”]。参考云主机机型说明。
Mem (int) - 内存大小。单位：MB
MinimalCpuPlatform (str) - 最低cpu平台，枚举值[“Intel/Auto”, “Intel/IvyBridge”, “Intel/Haswell”, “Intel/Broadwell”, “Intel/Skylake”, “Intel/Cascadelake”；”Intel/CascadelakeR”; “Amd/Epyc2”,”Amd/Auto”],默认值是”Intel/Auto”
Tag (str) - 业务组
Zone (str) - 可用区。参见可用区列表

Response

Message (str) - 返回错误消息，当 RetCode 非 0 时提供详细的描述信息。
NodeGroupId (str) - 节点池ID

add_uk8s_phost_node(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddUK8SPHostNode - 为UK8S集群添加一台或多台物理云主机类型的节点。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ChargeType (str) - (Required) 计费模式。枚举值为： > Year，按年付费； > Month，按月付费；默认为月付
ClusterId (str) - (Required) UK8S集群ID。可从UK8S控制台获取。
Count (int) - (Required) 最大创建Node节点数量，取值范围是[1,10]。
Password (str) - (Required) Node节点密码。请遵照字段规范设定密码。密码需使用base64进行编码，如下：# echo -n Password1 | base64
Zone (str) - (Required) 可用区。参见可用区列表
DisableSchedule (bool) - 用于标示添加完节点后是否将节点临时禁用. 传入 “true” 表示禁用,传入其它或不传表示不禁用
ImageId (str) - 镜像 Id，不填时后台程序会自动选用一个可用的镜像 Id，支持用户自定义镜像，自定义镜像必须基于基础镜像制作。
InitScript (str) - 用户自定义Shell脚本。与UserData的区别在于InitScript在节点初始化完毕后才执行。
Labels (str) - Node节点标签。key=value形式,多组用”,“隔开，最多5组。如env=pro,type=game
MaxPods (int) - 默认110，生产环境建议小于等于110。
NIC (str) - 网络环境，可选千兆：1G ，万兆：10G，默认1G。
Quantity (int) - 购买时长。默认: 1。月付时，此参数传0，代表了购买至月末。
Raid (str) - Raid配置，默认Raid10 支持:Raid0、Raid1、Raid5、Raid10，NoRaid
SubnetId (str) - 子网 ID。默认为集群创建时填写的子网ID，也可以填写集群同VPC内的子网ID。
Type (str) - 物理机类型，默认为：db-2(基础型-SAS-V3)

Response

Message (str) - 返回错误消息，当 RetCode 非 0 时提供详细的描述信息。

add_uk8s_uhost_node(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddUK8SUHostNode - 为UK8S集群添加一台Node节点，机型类型为云主机

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
CPU (int) - (Required) 虚拟CPU核数。可选参数：2-64（具体机型与CPU的对应关系参照控制台）。默认值: 4。
ChargeType (str) - (Required) 计费模式。枚举值为： > Year，按年付费； > Month，按月付费；> Dynamic，按小时预付费 > Postpay，按小时后付费（支持关机不收费，目前仅部分可用区支持，请联系您的客户经理）默认为月付
ClusterId (str) - (Required) UK8S集群ID。可从UK8S控制台获取。
Count (int) - (Required) 创建Node节点数量，取值范围是[1,50]。
Mem (int) - (Required) 内存大小。单位：MB。范围：[4096, 262144]，取值为1024的倍数（可选范围参考控制台）。默认值：8192
Password (str) - (Required) Node节点密码。请遵照字段规范设定密码。密码需使用base64进行编码，如下：# echo -n Password1 | base64
Zone (str) - (Required) 可用区。参见可用区列表
BootDiskType (str) - 磁盘类型。请参考磁盘类型。默认为SSD云盘
DataDiskSize (int) - 数据磁盘大小，单位GB。默认0。范围：[20, 1000]
DataDiskType (str) - 磁盘类型。请参考磁盘类型。默认为SSD云盘
DisableSchedule (bool) - 用于标示添加完节点后是否将节点临时禁用. 传入 “true” 表示禁用,传入其它或不传表示不禁用
GPU (int) - GPU卡核心数。仅GPU机型支持此字段（可选范围与MachineType+GpuType相关）
GpuType (str) - GPU类型，枚举值[“K80”, “P40”, “V100”,]，MachineType为G时必填
ImageId (str) - 镜像 Id，不填时后台程序会自动选用一个可用的镜像 Id，支持用户自定义镜像，自定义镜像必须基于基础镜像制作。
InitScript (str) - 用户自定义Shell脚本。与UserData的区别在于InitScript在节点初始化完毕后才执行，UserData则是云主机初始化时执行。
IsolationGroup (str) - 硬件隔离组id。可通过DescribeIsolationGroup获取。
Labels (str) - Node节点标签。key=value形式,多组用”,“隔开，最多5组。如env=pro,type=game
MachineType (str) - 云主机机型。枚举值[“N”, “C”, “G”, “O”, “OS”]。参考云主机机型说明。
MaxPods (int) - 默认110，生产环境建议小于等于110。
MinmalCpuPlatform (str) - 最低cpu平台，枚举值[“Intel/Auto”, “Intel/IvyBridge”, “Intel/Haswell”, “Intel/Broadwell”, “Intel/Skylake”, “Intel/Cascadelake”；”Intel/CascadelakeR”; “Amd/Epyc2”,”Amd/Auto”],默认值是”Intel/Auto”
Quantity (int) - 购买时长。默认: 1。按小时购买(Dynamic)时无需此参数。月付时，此参数传0，代表了购买至月末。
SubnetId (str) - 子网 ID。默认为集群创建时填写的子网ID，也可以填写集群同VPC内的子网ID。
UserData (str) - 用户自定义数据。当镜像支持Cloud-init Feature时可填写此字段。注意：1、总数据量大小不超过 16K；2、使用base64编码。

Response

NodeIds (list) - Node实例Id集合

create_uk8s_cluster_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUK8SClusterV2 - 创建UK8S集群

Request

ProjectId (str) - (Config) 项目ID。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ClusterName (str) - (Required) 集群名称
MasterCPU (int) - (Required) Master节点的虚拟CPU核数。可选参数：2-64（具体机型与CPU的对应关系参照控制台）。
MasterMachineType (str) - (Required) Master节点的云主机机型（V2.0），如[“N”, “C”, “O”, “OS”]，具体请参照云主机机型。
MasterMem (int) - (Required) Master节点的内存大小。单位：MB。范围：[4096, 262144]，取值为1024的倍数（可选范围参考控制台）。
Password (str) - (Required) 集群节点密码，包括Master和Node。密码需包含最少一个大写字母，请使用base64进行编码，举例如下：# echo -n Password1 | base64
ServiceCIDR (str) - (Required) Service 网段，用于分配ClusterIP，如172.17.0.0/16。该网段不能与集群所属VPC网段重叠。
SubnetId (str) - (Required) 集群Node及Pod所属子网
VPCId (str) - (Required) 集群Node及Pod所属VPC
ChargeType (str) - 集群所有节点的付费模式。枚举值为： Year，按年付费； Month，按月付费； Dynamic，按小时付费（需开启权限），默认按月。
ExternalApiServer (str) - 是否允许外网访问apiserver，开启：Yes 不开启：No。默认为No。
ImageId (str) - Master节点和Node节点的镜像 ID，不填则随机选择可用的基础镜像。支持用户自定义镜像。
InitScript (str) - 用户自定义脚本，与UserData不同，自定义脚本将在集群安装完毕后执行。注意：1、总数据量大小不超多16K；2、使用base64编码。
K8sVersion (str) - k8s集群的版本，版本信息请参考UK8S集群创建页，不指定的话默认为当前支持的最高版本。
KubeProxy (dict) - 见 CreateUK8SClusterV2ParamKubeProxy 模型定义
Master (list) - 见 CreateUK8SClusterV2ParamMaster 模型定义
MasterBootDiskType (str) - Master节点系统盘类型。请参考磁盘类型。默认为SSD云盘
MasterDataDiskSize (int) - Master节点的数据盘大小，单位GB，默认为0。范围：[20, 1000]
MasterDataDiskType (str) - Master节点数据盘类型。请参考磁盘类型。默认为SSD云盘
MasterIsolationGroup (str) - 【无效，已删除】当前将自动为Master节点创建隔离组，确保Master节点归属于不同物理机。
MasterMinmalCpuPlatform (str) - Master节点的最低cpu平台，不选则随机。枚举值[“Intel/Auto”, “Intel/IvyBridge”, “Intel/Haswell”, “Intel/Broadwell”, “Intel/Skylake”, “Intel/Cascadelake”。
Nodes (list) - 见 CreateUK8SClusterV2ParamNodes 模型定义
Quantity (int) - 购买时长。默认为1。按小时购买(Dynamic)时无需此参数。月付时，此参数传0，代表了购买至月末。
UserData (str) - 用户自定义数据。注意：1、总数据量大小不超多16K；2、使用base64编码。

Response

ClusterId (str) - 集群ID

Request Model

CreateUK8SClusterV2ParamKubeProxy - Mode (str) - 集群kube-proxy模式。支持iptables和ipvs，默认为iptables。

CreateUK8SClusterV2ParamMaster - Zone (str) - Master节点所属可用区，需要设置 Master.0.Zone、 Master.1.Zone、Master.2.Zone 三个 Master 节点的可用区。三个节点可部署在不同可用区。参见可用区列表

CreateUK8SClusterV2ParamNodes - BootDiskType (str) - 一组Node节点的系统盘类型，请参考磁盘类型。默认为SSD云盘 - CPU (int) - 一组Node节点的虚拟CPU核数。单位：核，范围：[2, 64]，可选范围参考控制台。 - Count (int) - 一组Node节点的数量，范围：[1,10]。 - DataDiskSize (int) - 数据磁盘大小，单位GB。默认0。范围：[20, 1000] - DataDiskType (str) - 一组Node节点的数据盘类型，请参考磁盘类型。默认为SSD云盘 - GPU (int) - 一组Node节点的GPU卡核心数，仅GPU机型支持此字段。 - GpuType (str) - 一组Node节点的GPU类型，枚举值[“K80”, “P40”, “V100”]，最新值参考Console。 - IsolationGroup (str) - 一组Node节点的隔离组Id，归属于同一隔离组的虚拟机节点将落在不同的物理机上，单个隔离组最多只能容纳8个节点。参见DescribeIsolationGroup。 - Labels (str) - Node节点标签，形式为key=value，多组Labels用”,“隔开,最多支持五组。 - MachineType (str) - 一组Nodes节点云主机机型，如[“N”, “C”, “O”, “OS”]，具体请参照云主机机型。 - MaxPods (int) - Node节点上可运行最大节点数，默认为110。 - Mem (int) - 一组Node节点的内存大小。单位：MB,范围：[4096, 262144]，取值为1024的倍数，可选范围参考控制台。 - MinmalCpuPlatform (str) - Node节点的最低cpu平台，不选则随机。枚举值[“Intel/Auto”, “Intel/IvyBridge”, “Intel/Haswell”, “Intel/Broadwell”, “Intel/Skylake”, “Intel/Cascadelake”。 - Zone (str) - 一组Nodes节点所属可用区，可创建多组Nodes节点，如一组是CPU Nodes节点，另一组是GPU Nodes节点。参见可用区列表

del_uk8s_cluster(req: Optional[dict] = None, **kwargs) → dict[source]¶

DelUK8SCluster - 删除UK8S集群

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ClusterId (str) - (Required) 集群id
ReleaseUDisk (bool) - 是否删除节点挂载的数据盘。枚举值[true:删除，false: 不删除]，默认不删除

Response

del_uk8s_cluster_node_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

DelUK8SClusterNodeV2 - 删除集群中的Node节点，删除前务必先将其中的Pod驱逐。

Request

ProjectId (str) - (Config) 项目ID项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ClusterId (str) - (Required) UK8S集群ID。可从UK8S控制台获取。
NodeId (str) - (Required) Node在UK8S处的唯一标示，如uk8s-reewqe5-sdasadsda。非云主机或物理云主机资源Id
ReleaseDataUDisk (bool) - 删除节点时是否释放数据盘。枚举值[true:释放，false: 不释放]，默认为true。

Response

Message (str) - 返回错误消息，当 RetCode 非 0 时提供详细的描述信息。

describe_uk8s_cluster(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUK8SCluster - 获取集群信息

Request

ProjectId (str) - (Config) 项目id
Region (str) - (Config) 所属区域
ClusterId (str) - (Required) k8s集群ID

Response

ApiServer (str) - 集群apiserver地址
CACert (str) - 集群CA根证书
ClusterDomain (str) - 自定义或者默认的clusterdomain
ClusterId (str) - 集群ID
ClusterName (str) - 资源名字
CreateTime (int) - 创建时间
EtcdCert (str) - 集群etcd服务证书
EtcdKey (str) - 集群etcd服务密钥
ExternalApiServer (str) - 集群外部apiserver地址
KubeProxy (dict) - kube-proxy配置
MasterCount (int) - Master 节点数量
MasterList (list) - 见 UhostInfo 模型定义
NodeCount (int) - Node节点数量
NodeList (list) - 见 UhostInfo 模型定义
PodCIDR (str) - Pod网段
ServiceCIDR (str) - 服务网段
Status (str) - 状态
SubnetId (str) - 所属子网
VPCId (str) - 所属VPC
Version (str) - K8S版本

Response Model

UhostInfo - CPU (int) - Cpu数量 - CreateTime (int) - 创建时间 - DiskSet (list) - 见 DiskSet 模型定义 - ExpireTime (int) - 到期时间 - IPSet (list) - 见 IPSet 模型定义 - Memory (int) - 内存 - Name (str) - 主机名称 - NodeId (str) - 主机ID - NodeType (str) - 节点类型：uhost表示云主机;uphost表示物理云主机 - OsName (str) - 镜像信息 - State (str) - 主机状态 - Zone (str) - 所在机房

DiskSet - BackupType (str) - 备份方案，枚举类型：BASIC_SNAPSHOT,普通快照；DATAARK,方舟。无快照则不返回该字段。 - DiskId (str) - 磁盘长ID - DiskType (str) - LOCAL_NOMAL| CLOUD_NORMAL| LOCAL_SSD| CLOUD_SSD|EXCLUSIVE_LOCAL_DISK - Drive (str) - 磁盘盘符 - Encrypted (str) - Yes: 加密 No: 非加密 - IOPS (int) - 当前主机的IOPS值 - IsBoot (str) - True| False - Name (str) - UDisk名字（仅当磁盘是UDisk时返回） - Size (int) - 磁盘大小，单位: GB - Type (str) - 磁盘类型。系统盘: Boot，数据盘: Data,网络盘：Udisk

IPSet - Bandwidth (int) - IP对应的带宽, 单位: Mb (内网IP不显示带宽信息) - Default (str) - 是否默认的弹性网卡的信息。true: 是默认弹性网卡；其他值：不是。 - IP (str) - IP地址 - IPId (str) - IP资源ID (内网IP无对应的资源ID) - Type (str) - 国际: Internation，BGP: Bgp，内网: Private

describe_uk8s_image(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUK8SImage - 获取UK8S支持的Node节点操作系统，可基于该操作系统制定自定义镜像

Request

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

Response

ImageSet (list) - 见 ImageInfo 模型定义
Message (str) - 返回错误消息，当 RetCode 非 0 时提供详细的描述信息。
PHostImageSet (list) - 见 ImageInfo 模型定义

Response Model

ImageInfo - ImageId (str) - 镜像 Id - ImageName (str) - 镜像名称 - NotSupportGPU (bool) - 该镜像是否支持GPU机型，枚举值[true:不支持，false:支持]。 - ZoneId (int) - 可用区 Id

describe_uk8s_node(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUK8SNode - 用于获取 UK8S 节点详情

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ClusterId (str) - (Required) UK8S 集群 Id
Name (str) - (Required) K8S 节点IP或者节点ID

Response

Action (str) - 操作名称
AllocatedPodCount (int) - 已分配到当前节点的 Pod 数量
Annotations (list) - 字符串数组，每一项是类似 “node.alpha.kubernetes.io/ttl=0” 的注解
CPUCapacity (str) - 节点 CPU 总量
CPULimits (str) - 节点上已分配 Pod 的 CPU 限制值
CPULimitsFraction (str) - 节点上已分配 Pod 的 CPU 限制值占 CPU 总量的比例
CPURequests (str) - 节点上已分配 Pod 的 CPU 请求量
CPURequestsFraction (str) - 节点上已分配 Pod 的 CPU 请求量占 CPU 总量的比例
Conditions (list) - 见 K8SNodeCondition 模型定义
ContainerImages (list) - 节点上镜像名称数组
ContainerRuntimeVersion (str) - 容器运行时版本，如：”docker://18.9.9”
CreationTimestamp (int) - 时间戳，单位是秒
Hostname (str) - 主机名
InternalIP (str) - 内部 IP 地址
KernelVersion (str) - 内核版本，如：”4.19.0-6.el7.ucloud.x86_64”
KubeProxyVersion (str) - kubeproxy 版本
KubeletVersion (str) - kubelet 版本
Labels (list) - 字符串数组，每一项是类似 “kubernetes.io/arch=amd64” 的标签
MemoryCapacity (str) - 节点内存总量
MemoryLimits (str) - 节点上已分配 Pod 的内存限制量
MemoryLimitsFraction (str) - 节点上已分配 Pod 的内存限制量占内存总量的比例，如返回值为 “18”，则意味着限制量占总量的 18%
MemoryRequests (str) - 节点上已分配 Pod 的内存请求量
MemoryRequestsFraction (str) - 节点上已分配 Pod 的内存请求量占内存总量的比例，如返回值为 “4.5”，则意味着请求量占总量的 4.5%
Message (str) - 操作出错时的提示信息
Name (str) - 节点名称
OSImage (str) - 操作系统类型，如：”CentOS Linux 7 (Core)”
PodCapacity (int) - 节点允许的可分配 Pod 最大数量
ProviderID (str) - 字符串，如：”UCloud://cn-sh2-02//uk8s-vsc0vgob-n-mpzxc”
RetCode (int) - 返回码
Taints (list) - 字符串数组，每一项是类似 “node-role.kubernetes.io/master:NoSchedule” 的污点
Unschedulable (bool) - 是否禁止调度

Response Model

K8SNodeCondition - LastProbeTime (str) - 最后一次上报状态的时间 - LastTransitionTime (str) - 最后一次状态转变时间 - Message (str) - 状态变化的描述信息 - Reason (str) - 状态变化的原因 - Status (str) - 状态，False、True - Type (str) - Condition 类型，如 MemoryPressure、DiskPressure、PIDPressure、Ready

list_uk8s_cluster_node_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListUK8SClusterNodeV2 - 获取UK8S集群节点信息

Request

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

Response

NodeSet (list) - 见 NodeInfoV2 模型定义
TotalCount (int) - 满足条件的节点数量，包括Master。

Response Model

NodeInfoV2 - AsgId (str) - 节点所属伸缩组ID，非伸缩组创建出来的节点，伸缩组ID为Default。 - CPU (int) - Node节点CPU核数，单位: 个。 - CreateTime (int) - 节点创建时间 - ExpireTime (int) - 节点计费到期时间 - GPU (int) - 节点的GPU颗数。 - IPSet (list) - 见 UHostIPSet 模型定义 - InstanceId (str) - 资源ID，如uhost-xxxx，或uphost-xxxxx。 - InstanceName (str) - 资源名称，初始值等于NodeId，用户可在UHost或UPHost处修改。 - InstanceType (str) - Node节点的资源类型，枚举值为UHost或UPHost。 - KubeProxy (dict) - 见 KubeProxy 模型定义 - MachineType (str) - 机型类别，分别对应Uhost的MachineType或PHost的PHostType。 - Memory (int) - 内存大小，单位: MB。 - NodeId (str) - NodeId，Node在UK8S处的唯一标示，如uk8s-reewqe5-sdasadsda - NodeLogInfo (str) - 加节点时判断是否没有资源，如果返回NORESOURCE则代表没有资源了 - NodeRole (str) - node角色，枚举值为master、node - NodeStatus (str) - Node的状态：枚举值：初始化：”Initializing”；启动中：”Starting”；运行：”Running”；停止中：”Stopping”；停止：”Stopped”；待删除：”ToBeDeleted”；删除中：”Deleting”；异常：”Error”；安装失败：”Install Fail”； - OsName (str) - Node节点的镜像名称。 - OsType (str) - Node节点的操作系统类别，如Linux或Windows。 - Unschedulable (bool) - 是否允许Pod调度到该节点，枚举值为true或false。 - Zone (str) - Node所在可用区

UHostIPSet - Bandwidth (int) - IP对应的带宽, 单位: Mb (内网IP不显示带宽信息) - 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

KubeProxy - Mode (str) - KubeProxy模式，枚举值为[ipvs,iptables]

list_uk8s_cluster_v2(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListUK8SClusterV2 - 获取UK8S集群列表信息

Request

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

Response

ClusterCount (int) - 满足条件的集群数量
ClusterSet (list) - 见 ClusterSet 模型定义

Response Model

ClusterSet - ApiServer (str) - 集群apiserver地址 - ClusterId (str) - 集群ID - ClusterLogInfo (str) - 创建集群时判断如果为NORESOURCE则为没资源，否则为空 - ClusterName (str) - 资源名字 - CreateTime (int) - 创建时间 - ExternalApiServer (str) - 集群外部apiserver地址 - K8sVersion (str) - 集群版本 - MasterCount (int) - Master 节点数量 - NodeCount (int) - Node节点数量 - PodCIDR (str) - Pod网段 - ServiceCIDR (str) - 服务网段 - Status (str) - 集群状态，枚举值：初始化：”INITIALIZING”；启动中：”STARTING”；创建失败：”CREATEFAILED”；正常运行：”RUNNING”；添加节点：”ADDNODE”；删除节点：”DELNODE”；删除中：”DELETING”；删除失败：”DELETEFAILED”；错误：”ERROR”；升级插件：”UPDATE_PLUGIN”；更新插件信息：”UPDATE_PLUGIN_INFO”；异常：”ABNORMAL”；升级集群中：”UPGRADING”；容器运行时切换：”CONVERTING” - SubnetId (str) - 所属子网 - VPCId (str) - 所属VPC

list_uk8s_node_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListUK8SNodeGroup - 列出UK8S节点池

Request

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

Response

NodeGroupList (list) - 见 NodeGroupSet 模型定义

Response Model

NodeGroupSet - BootDiskType (str) - 系统盘类型 - CPU (int) - 虚拟CPU核数 - ChargeType (str) - 付费方式 - DataDiskSize (int) - 数据盘大小 - DataDiskType (str) - 数据盘类型 - GPU (int) - GPU卡核心数 - GpuType (str) - GPU类型 - ImageId (str) - 镜像ID - MachineType (str) - 机型 - Mem (int) - 内存大小 - MinimalCpuPlatform (str) - cpu平台 - NodeGroupId (str) - 节点池ID - NodeGroupName (str) - 节点池名字 - NodeList (list) - 节点id列表 - Tag (str) - 业务组

remove_uk8s_node_group(req: Optional[dict] = None, **kwargs) → dict[source]¶

RemoveUK8SNodeGroup - 删除UK8S节点池

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
ClusterId (str) - (Required) 集群id
NodeGroupId (str) - (Required) 节点池Id
Zone (str) - 可用区。参见可用区列表

Response

UNVS¶

class ucloud.services.unvs.client.UNVSClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

get_mobile(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetMobile - 一键登录

Request

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

Response

Data (dict) - 见 PhoneInfo 模型定义
Message (str) - 发生错误时表示错误字符串
ReqUuid (str) - 本次请求Uuid

Response Model

PhoneInfo - Phone (str) - 返回的电话号码

verify_mobile(req: Optional[dict] = None, **kwargs) → dict[source]¶

VerifyMobile - 号码检测

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BusinessId (str) - (Required) 业务ID
Phone (str) - (Required) 需要检测的手机号
Token (str) - (Required) token
Zone (str) - 可用区。参见可用区列表

Response

Data (dict) - 见 VerifyInfo 模型定义
Message (str) - 发生错误时表示错误字符串
ReqUuid (str) - 本次请求Uuid

Response Model

VerifyInfo - VerifyResult (str) - 检测结果：PASS：一致，REJECT：不一致

UTSDB¶

class ucloud.services.utsdb.client.UTSDBClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

check_uinfluxdb_allowance(req: Optional[dict] = None, **kwargs) → dict[source]¶

CheckUInfluxdbAllowance - 检查UInfluxdb剩余资源

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Count (int) - (Required) 创建实例的数量，[1-10]
CpuLimit (int) - (Required) 核数单位：个，范围［2C8G, 4C16G, 8C32G, 16C64G, 32C128G］
MemoryLimit (int) - (Required) 内存限制单位：G 范围 [2C8G, 4C16G, 8C32G, 16C64G, 32C128G］
Zone (str) - (Required) 可用区。参见可用区列表

Response

Count (int) - 可创建的数量

create_uinfluxdb_database(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUInfluxdbDatabase - 创建Influxdb数据库

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DatabaseName (str) - (Required) Influxdb创建的数据库的名称
UInfluxdbId (str) - (Required) 实例ID
Zone (str) - (Required) 可用区。参见可用区列表
AccoutName (str) - Influxdb数据库账号
Description (str) - Influxdb数据库的描述
RetentionPolicy (str) - 数据保留策略，以天为单位，比如（1d，2d，3d等，inf为永久保留策略，默认为inf）

Response

create_uinfluxdb_database_rp(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUInfluxdbDatabaseRP - 给指定的database创建一个保留策略，最多可以创建10个RP

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DatabaseName (str) - (Required) 要创建RP的数据库
RetentionPolicy (str) - (Required) 数据保留策略，以天为单位，比如（1d，2d，3d等，inf为永久保留策略，默认为inf）
RetentionPolicyName (str) - (Required) 保留策略名
UInfluxdbId (str) - (Required) 实例ID
Zone (str) - (Required) 可用区。参见可用区列表

Response

Message (str) - 如果执行失败, 失败的错误消息

create_uinfluxdb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateUInfluxdbInstance - 创建UInfluxdb实例

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AccountName (str) - (Required) 默认账户
ChargeType (str) - (Required) 付费类型，后付费阶段固定为：后付费（PostPaid）
CpuLimit (int) - (Required) 核数单位：个，范围［2C8G, 4C16G, 8C32G, 16C64G, 32C128G］
DatabaseName (str) - (Required) 数据库名称
MemoryLimit (int) - (Required) 内存限制单位：G 范围 [2C8G, 4C16G, 8C32G, 16C64G, 32C128G］
Name (str) - (Required) 实例名称，长度(6<=size<=63)
Password (str) - (Required) 默认账户的密码，需要 base64 编码
Quantity (int) - (Required) 购买时长，默认值1
SubnetId (str) - (Required) 子网 id
VPCId (str) - (Required) VPC id
Zone (str) - (Required) 可用区。参见可用区列表
CouponId (str) - 使用的代金券id
Tag (str) - 业务组名称

Response

UInfluxdbId (str) - 返回的实例id

delete_uinfluxdb_database(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUInfluxdbDatabase - 删除Influxdb实例的数据库

Request

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

Response

delete_uinfluxdb_database_rp(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUInfluxdbDatabaseRP - 删除指定数据库下面的一个数据保留策略

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DatabaseName (str) - (Required) 要删除的RP所在数据库
RetentionPolicyName (str) - (Required) 要删除的保留策略
UInfluxdbId (str) - (Required) 实例ID
Zone (str) - (Required) 可用区。参见可用区列表

Response

Message (str) - 如果执行失败, 失败的错误消息

delete_uinfluxdb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteUInfluxdbInstance - 删除UInfluxdb实例

Request

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

Response

describe_uinfluxdb_database(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUInfluxdbDatabase - 描述UInfluxdb数据库

Request

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

Response

DatabaseInfo (list) - 见 DatabaseInfo 模型定义

Response Model

AccountInfo - Account (str) - 账户名 - Password (str) - 密码 - Privilege (str) - 权限

DatabaseInfo - AccountInfo (list) - 见 AccountInfo 模型定义 - DatabaseName (str) - 数据库名 - Description (str) - 数据库描述 - RetentionPolicy (str) - 保留策略 - State (str) - 数据库状态

describe_uinfluxdb_database_rp(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUInfluxdbDatabaseRP - 获取指定数据库下面的所有保留策略

Request

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

Response

DataSet (list) - 见 RpData 模型定义
Message (str) - 如果执行失败, 失败的错误消息

Response Model

RpData - Policy (str) - 保留策略 - RetentionPolicyName (str) - 保留策略名

describe_uinfluxdb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUInfluxdbInstance - 拉取UInfluxdb实例列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Zone (str) - (Required) 可用区。参见可用区列表
Limit (int) - 分页显示数量，列表操作则指定
Offset (int) - 分页显示起始偏移位置，列表操作则指定
UInfluxdbId (str) - 指定id的话，会拉取该实例信息，否则拉取该帐号所有信息

Response

DataSet (list) - 见 UInfluxdbDataSet 模型定义

Response Model

UInfluxdbDataSet - AccountName (str) - 账户名 - CPULimit (int) - 实例核数 - ChargeType (str) - 付费类型，可选值如下: Year: 按年付费 Month: 按月付费 Dynamic: 按需付费(单位: 小时) Trial: 免费试用 - CreateTime (int) - 创建时间 - ExpiredTime (int) - 修改时间 - MemoryLimit (int) - 实例内存 - Name (str) - 实例名称 - Port (int) - 实例端口 - State (str) - 实例状态 - SubnetId (str) - 子网ID - Tag (str) - 业务组信息 - UInfluxdbId (str) - 实例id - UsedSize (int) - 硬盘使用量 - VPCId (str) - VPC的ID - VirtualIP (str) - 实例ip - Zone (str) - UInfluxdb实例所在可用区

describe_uinfluxdb_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUInfluxdbPrice - 获取UInfluxdb价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
CpuLimit (int) - (Required) 核数单位：个，规格［2C8G, 4C16G, 8C32G, 16C64G, 32C128G］
Zone (str) - (Required) 可用区。参见可用区列表
ChargeType (str) - 付费类型，后付费。填：PostPaid (后付费)
MemoryLimit (int) - 内存限制单位：G 规格 [2C8G, 4C16G, 8C32G, 16C64G, 32C128G］
Quantity (int) - 付费周期数量

Response

OriginalPrice (float) - 原价
Price (float) - 价格

describe_uinfluxdb_upgrade_price(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeUInfluxdbUpgradePrice - 获取UIfluxdb升降级价格

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
CpuLimit (int) - (Required) 核数
MemoryLimit (int) - (Required) 容量，单位GB
UInfluxdbId (str) - (Required) UInfluxdb 实例id
Zone (str) - (Required) 可用区。参见可用区列表

Response

OriginalPrice (float) - 原价
TotalPrice (float) - 升降级价格

modify_uinfluxdb_database_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyUInfluxdbDatabasePolicy - 更改UInfluxdb实例数据库数据保留策略

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DatabaseName (str) - (Required) 数据库名
RetentionPolicy (str) - (Required) 数据库数据保留策略。自定义格式如：10d（即10天），2w（即两周），
UInfluxdbId (str) - (Required) Influxdb实例id
Zone (str) - (Required) 可用区。参见可用区列表

Response

reboot_uinfluxdb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

RebootUInfluxdbInstance - 重启UInfluxdb实例

Request

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

Response

reset_uinfluxdb_instance_name(req: Optional[dict] = None, **kwargs) → dict[source]¶

ResetUInfluxdbInstanceName - 更改UIfluxdb实例名称

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NewName (str) - (Required) 实例的新名字, 长度要求为6~63位
UInfluxdbId (str) - (Required) UInfluxdb实例id
Zone (str) - (Required) 可用区。参见可用区列表

Response

start_uinfluxdb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

StartUInfluxdbInstance - 启动UInfluxdb实例

Request

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

Response

stop_uinfluxdb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

StopUInfluxdbInstance - 关闭UInfluxdb实例

Request

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

Response

upgrade_uinfluxdb_instance(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpgradeUInfluxdbInstance - UInfluxdb实例配置升降级

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
CpuLimit (int) - (Required) UInfluxdb 实例新的核数，单位个
MemoryLimit (int) - (Required) UInfluxdb 实例新的内存
UInfluxdbId (str) - (Required) 实例ID
Zone (str) - (Required) 可用区。参见可用区列表

Response

UVMS¶

class ucloud.services.uvms.client.UVMSClient(config: dict, transport=None, middleware=None, logger=None)[source]¶

send_uvms_message(req: Optional[dict] = None, **kwargs) → dict[source]¶

SendUVMSMessage - 向指定号码拨打电话

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
CalledNumber (str) - (Required) 被叫号码，采用 E.164 标准，格式为+[国家代码][用户号码]。例如：+8613512345678，其中前面有一个+号，86为国家码，13512345678为手机号
TemplateId (str) - (Required) 模板 ID，在控制台审核通过的模板 ID。
Zone (str) - (Required) 可用区。参见可用区列表
FromNumber (str) - 主叫号码，号码随机时不填。专属号码时传入已购买的号码，仅支持一个号码，在控制台查看已购买的号码。
TemplateParams (list) - 模板可变参数，以数组的方式填写，举例，TemplateParams.0，TemplateParams.1，… 若模板中无可变参数，则该项可不填写；若模板中有可变参数，则该项为必填项，参数个数需与变量个数保持一致，否则无法发送；
UserId (str) - 自定义的业务标识ID，字符串（长度不能超过32 位），不支持单引号、表情包符号等特殊字符

Response

Message (str) - 状态码的描述
ReqUuid (str) - 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 ReqUuid。
SessionNo (str) - 本次提交发送语音的唯一ID，可根据该值查询本次发送详情
UserId (str) - 本次提交的自定义业务标识ID，仅当发送时传入有效的UserId，才返回该字段。

VPC¶

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

add_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddSnatRule - 对于绑定了多个EIP的NAT网关，您可以将一个子网下的某台云主机映射到某个特定的EIP上，规则生效后，则该云主机通过该特定的EIP访问互联网。

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关的ID
SnatIp (str) - (Required) EIP的ip地址,例如106.75.xx.xx
SourceIp (str) - (Required) 需要出外网的私网IP地址，例如10.9.7.xx
Name (str) - snat规则名称，默认为“出口规则”

Response

add_vpc_network(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddVPCNetwork - 添加VPC网段

Request

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

Response

add_white_list_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

AddWhiteListResource - 添加NAT网关白名单

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
ResourceIds (list) - (Required) 可添加白名单的资源Id

Response

allocate_secondary_ip(req: Optional[dict] = None, **kwargs) → dict[source]¶

AllocateSecondaryIp - 分配ip（用于uk8s使用）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Mac (str) - (Required) 节点mac
ObjectId (str) - (Required) 资源Id
Zone (str) - (Required) 可用区。参见可用区列表
Ip (str) - 指定Ip分配
SubnetId (str) - 子网Id（若未指定，则根据zone获取默认子网进行创建）
VPCId (str) - vpcId

Response

IpInfo (dict) - 见 IpInfo 模型定义

Response Model

IpInfo - Gateway (str) - - Ip (str) - - Mac (str) - - Mask (str) - - SubnetId (str) - - VPCId (str) -

allocate_vip(req: Optional[dict] = None, **kwargs) → dict[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_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

AssociateRouteTable - 绑定子网的路由表

Request

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

Response

clone_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

CloneRouteTable - 将现有的路由表复制为一张新的路由表

Request

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

Response

RouteTableId (str) - 复制后新的路由表资源ID

create_natgw(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNATGW - 创建NAT网关

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
EIPIds (list) - (Required) NAT网关绑定的EIPId
FirewallId (str) - (Required) NAT网关绑定的防火墙Id
NATGWName (str) - (Required) NAT网关名称
SubnetworkIds (list) - (Required) NAT网关绑定的子网Id
IfOpen (int) - 白名单开关标记。0表示关闭，1表示开启。默认为0
Remark (str) - 备注。默认为空
Tag (str) - 业务组。默认为空
VPCId (str) - NAT网关所属的VPC Id。默认为Default VPC Id

Response

NATGWId (str) - 申请到的NATGateWay Id

create_natgw_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNATGWPolicy - 添加NAT网关端口转发规则

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DstIP (str) - (Required) 目标IP。填写对应的目标IP地址
DstPort (str) - (Required) 目标端口。可填写固定端口，也可填写端口范围。支持的端口范围为1-65535
NATGWId (str) - (Required) NAT网关Id
Protocol (str) - (Required) 协议类型。枚举值为：TCP、UDP
SrcEIPId (str) - (Required) 源IP。填写对应的EIP Id
SrcPort (str) - (Required) 源端口。可填写固定端口，也可填写端口范围。支持的端口范围为1-65535
PolicyName (str) - 转发策略名称。默认为空

Response

PolicyId (str) - 创建时分配的策略Id

create_network_acl(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNetworkAcl - 创建网络ACL

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclName (str) - (Required) ACL的名称
VpcId (str) - (Required) 将要创建的ACL所属VPC的ID
Description (str) - ACL的描述

Response

AclId (str) - 创建的ACL的ID

create_network_acl_association(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNetworkAclAssociation - 创建ACL的绑定关系

Request

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

Response

AssociationId (str) - 创建的绑定关系的ID
PrevAssociation (dict) - 见 AssociationInfo 模型定义

Response Model

AssociationInfo - AclId (str) - ACL的ID - AssociationId (str) - 绑定ID - CreateTime (int) - 创建的Unix时间戳 - SubnetworkId (str) - 绑定的子网ID

create_network_acl_entry(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateNetworkAclEntry - 创建ACL的规则

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclId (str) - (Required) ACL的ID
CidrBlock (str) - (Required) IPv4段的CIDR表示
Direction (str) - (Required) 出向或者入向（“Ingress”, “Egress”)
EntryAction (str) - (Required) 规则的行为(“Accept”, “Reject”)
IpProtocol (str) - (Required) 协议规则描述
PortRange (str) - (Required) 针对的端口范围
Priority (int) - (Required) Entry的优先级，对于同样的Direction来说，不能重复
Description (str) - 描述。长度限制为不超过32字节。
TargetResourceIds (list) - 应用目标资源列表。默认为全部资源生效。TargetType为0时不用填写该值。
TargetType (int) - 应用目标类型。0代表“子网内全部资源”，1代表“子网内指定资源”，默认为0

Response

EntryId (str) - 创建的Entry的ID

create_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

CreateRouteTable - 创建路由表

Request

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

Response

RouteTableId (str) - 路由表ID

create_subnet(req: Optional[dict] = None, **kwargs) → dict[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: Optional[dict] = None, **kwargs) → dict[source]¶

CreateVPC - 创建VPC

Request

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

Response

VPCId (str) - VPC资源Id

create_vpc_intercom(req: Optional[dict] = None, **kwargs) → dict[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_natgw(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNATGW - 删除NAT网关

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
ReleaseEip (bool) - 是否释放绑定的EIP。true：解绑并释放；false：只解绑不释放。默认为false

Response

delete_natgw_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNATGWPolicy - 删除NAT网关端口转发规则

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
PolicyId (str) - (Required) 端口转发规则Id

Response

delete_network_acl(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNetworkAcl - 删除网络ACL

Request

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

Response

delete_network_acl_association(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNetworkAclAssociation - 删除网络ACL绑定关系

Request

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

Response

delete_network_acl_entry(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteNetworkAclEntry - 删除ACL的规则

Request

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

Response

delete_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteRouteTable - 删除自定义路由表

Request

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

Response

delete_secondary_ip(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteSecondaryIp - 删除ip（用于uk8s使用）

Request

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

Response

delete_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteSnatRule - 删除指定的出口规则（SNAT规则）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关的ID
SourceIp (str) - (Required) 需要出外网的私网IP地址，例如10.9.7.xx

Response

delete_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteSubnet - 删除子网

Request

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

Response

delete_vpc(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteVPC - 删除VPC

Request

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

Response

delete_vpc_intercom(req: Optional[dict] = None, **kwargs) → dict[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

delete_white_list_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

DeleteWhiteListResource - 删除NAT网关白名单列表

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
ResourceIds (list) - (Required) 删除白名单的资源Id

Response

describe_natgw(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNATGW - 获取NAT网关信息

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (int) - 数据分页值。默认为20
NATGWIds (list) - NAT网关Id。默认为该项目下所有NAT网关
Offset (int) - 数据偏移量。默认为0

Response

DataSet (list) - 见 NatGatewayDataSet 模型定义
TotalCount (int) - 满足条件的实例的总数

Response Model

NatGWIPResInfo - EIP (str) - 外网IP - OperatorName (str) - IP的运营商信息

NatGatewayIPSet - Bandwidth (int) - 带宽 - BandwidthType (str) - EIP带宽类型 - EIPId (str) - 外网IP的 EIPId - IPResInfo (list) - 见 NatGWIPResInfo 模型定义 - Weight (int) - 权重为100的为出口

NatGatewaySubnetSet - Subnet (str) - 子网网段 - SubnetName (str) - 子网名字 - SubnetworkId (str) - 子网id

NatGatewayDataSet - CreateTime (int) - natgw创建时间 - FirewallId (str) - 绑定的防火墙Id - IPSet (list) - 见 NatGatewayIPSet 模型定义 - NATGWId (str) - natgw id - NATGWName (str) - natgw名称 - PolicyId (list) - 转发策略Id - Remark (str) - 备注 - SubnetSet (list) - 见 NatGatewaySubnetSet 模型定义 - Tag (str) - 业务组 - VPCId (str) - 所属VPC Id

describe_natgw_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNATGWPolicy - 展示NAT网关端口转发规则

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
Limit (int) - 返回数据长度，默认为10000
Offset (int) - 列表起始位置偏移量，默认为0

Response

DataSet (list) - 见 NATGWPolicyDataSet 模型定义
TotalCount (int) - 满足条件的转发策略总数

Response Model

NATGWPolicyDataSet - DstIP (str) - 目的地址 - DstPort (str) - 目的端口 - NATGWId (str) - NAT网关Id - PolicyId (str) - 转发策略Id - PolicyName (str) - 转发策略名称 - Protocol (str) - 协议类型 - SrcEIP (str) - 端口转发前端EIP - SrcEIPId (str) - 端口转发前端EIP Id - SrcPort (str) - 源端口

describe_network_acl(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNetworkAcl - 获取网络ACL

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Limit (str) - 列表获取的个数限制
Offset (int) - 列表偏移量
VpcId (str) - 需要获取的ACL所属的VPC的ID

Response

AclList (list) - 见 AclInfo 模型定义

Response Model

TargetResourceInfo - PrivateIp (str) - 资源内网IP - ResourceId (str) - 资源ID - ResourceName (str) - 资源名称 - ResourceType (int) - 资源类型 - SubResourceId (str) - 资源绑定的虚拟网卡的ID - SubResourceName (str) - 资源绑定的虚拟网卡的名称 - SubResourceType (int) - 资源绑定虚拟网卡的类型 - SubnetworkId (str) - 子网ID

AssociationInfo - AclId (str) - ACL的ID - AssociationId (str) - 绑定ID - CreateTime (int) - 创建的Unix时间戳 - SubnetworkId (str) - 绑定的子网ID

AclEntryInfo - CidrBlock (str) - IP段的CIDR信息 - CreateTime (int) - 创建的Unix时间戳 - Direction (str) - 出向或者入向 - EntryAction (str) - 匹配规则的动作 - EntryId (str) - Entry的ID - IpProtocol (str) - 针对的IP协议 - PortRange (str) - Port的段信息 - Priority (str) - 优先级 - TargetResourceCount (int) - 应用目标资源数量。TargetType为0时不返回该值。 - TargetResourceList (list) - 见 TargetResourceInfo 模型定义 - TargetType (int) - 应用目标类型。 0代表“子网内全部资源” ，1代表“子网内指定资源” 。 - UpdateTime (int) - 更改的Unix时间戳

AclInfo - AclId (str) - ACL的ID - AclName (str) - 名称 - Associations (list) - 见 AssociationInfo 模型定义 - CreateTime (int) - 创建的Unix时间戳 - Description (str) - 描述 - Entries (list) - 见 AclEntryInfo 模型定义 - UpdateTime (int) - 更改的Unix时间戳 - VpcId (str) - ACL所属的VPC ID

describe_network_acl_association(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNetworkAclAssociation - 获取网络ACL的绑定关系列表

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclId (str) - (Required) Acl的ID
Limit (str) - 列表获取的个数限制
Offset (int) - 列表偏移量

Response

AssociationList (list) - 见 AssociationInfo 模型定义

Response Model

AssociationInfo - AclId (str) - ACL的ID - AssociationId (str) - 绑定ID - CreateTime (int) - 创建的Unix时间戳 - SubnetworkId (str) - 绑定的子网ID

describe_network_acl_association_by_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNetworkAclAssociationBySubnet - 获取子网的ACL绑定信息

Request

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

Response

Association (dict) - 见 AssociationInfo 模型定义

Response Model

AssociationInfo - AclId (str) - ACL的ID - AssociationId (str) - 绑定ID - CreateTime (int) - 创建的Unix时间戳 - SubnetworkId (str) - 绑定的子网ID

describe_network_acl_entry(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeNetworkAclEntry - 获取ACL的规则信息

Request

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

Response

EntryList (list) - 见 AclEntryInfo 模型定义

Response Model

TargetResourceInfo - PrivateIp (str) - 资源内网IP - ResourceId (str) - 资源ID - ResourceName (str) - 资源名称 - ResourceType (int) - 资源类型 - SubResourceId (str) - 资源绑定的虚拟网卡的ID - SubResourceName (str) - 资源绑定的虚拟网卡的名称 - SubResourceType (int) - 资源绑定虚拟网卡的类型 - SubnetworkId (str) - 子网ID

AclEntryInfo - CidrBlock (str) - IP段的CIDR信息 - CreateTime (int) - 创建的Unix时间戳 - Direction (str) - 出向或者入向 - EntryAction (str) - 匹配规则的动作 - EntryId (str) - Entry的ID - IpProtocol (str) - 针对的IP协议 - PortRange (str) - Port的段信息 - Priority (str) - 优先级 - TargetResourceCount (int) - 应用目标资源数量。TargetType为0时不返回该值。 - TargetResourceList (list) - 见 TargetResourceInfo 模型定义 - TargetType (int) - 应用目标类型。 0代表“子网内全部资源” ，1代表“子网内指定资源” 。 - UpdateTime (int) - 更改的Unix时间戳

describe_route_table(req: Optional[dict] = None, **kwargs) → dict[source]¶

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

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
BusinessId (str) - 业务组ID
Limit (int) - 数据分页值。默认为20
OffSet (int) - 数据偏移量。默认为0
RouteTableId (str) - 路由表资源ID
VPCId (str) - 所属VPC的资源ID

Response

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

Response Model

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

RouteRuleInfo - AccountId (int) - 项目ID信息 - DstAddr (str) - 目的地址 - DstPort (int) - 保留字段，暂未使用 - NexthopId (str) - 路由下一跳资源ID - NexthopType (str) - 路由表下一跳类型。LOCAL，本VPC内部通信路由；PUBLIC，公共服务路由；CNAT，外网路由；UDPN，跨域高速通道路由；HYBRIDGW，混合云路由；INSTANCE，实例路由；VNET，VPC联通路由；IPSEC VPN，指向VPN网关的路由。 - OriginAddr (str) - 保留字段，暂未使用 - Priority (int) - 保留字段，暂未使用 - Remark (str) - 路由规则备注 - RouteRuleId (str) - 规则ID - RouteTableId (str) - 路由表资源ID - RuleType (int) - 路由规则类型。0，系统路由规则；1，自定义路由规则 - SrcAddr (str) - 保留字段，暂未使用 - SrcPort (int) - 保留字段，暂未使用 - VNetId (str) - 所属的VPC

describe_secondary_ip(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeSecondaryIp - 查询SecondaryIp（uk8s使用）

Request

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

Response

DataSet (list) - 见 IpInfo 模型定义

Response Model

IpInfo - Gateway (str) - - Ip (str) - - Mac (str) - - Mask (str) - - SubnetId (str) - - VPCId (str) -

describe_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeSnatRule - 获取Nat网关的出口规则（SNAT规则）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关的ID
Limit (str) - 分页，默认为20
Offset (str) - 偏移，默认为0
SnatIp (str) - EIP的ip地址,例如106.75.xx.xx
SourceIp (str) - 需要出外网的私网IP地址，例如10.9.7.xx

Response

DataSet (list) - 见 NATGWSnatRule 模型定义
TotalCount (int) - 规则数量

Response Model

NATGWSnatRule - Name (str) - snat规则名称 - SnatIp (str) - EIP地址，如106.76.xx.xx - SourceIp (str) - 资源的内网IP地址 - SubnetworkId (str) - SourceIp所属的子网id

describe_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeSubnet - 获取子网信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
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: Optional[dict] = None, **kwargs) → dict[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 - Name (str) - 名称 - ResourceId (str) - 资源Id - ResourceType (str) - 资源类型。对应的资源类型：UHOST，云主机；PHOST，物理云主机；ULB，负载均衡；UHADOOP_HOST，hadoop节点；UFORTRESS_HOST，堡垒机；UNATGW，NAT网关；UKAFKA，分布式消息系统；UMEM，内存存储；DOCKER，容器集群；UDB，数据库；UDW，数据仓库；VIP，内网VIP.

describe_vip(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeVIP - 获取内网VIP详细信息

Request

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

Response

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

Response Model

VIPDetailSet - CreateTime (int) - 创建时间 - Name (str) - VIP名称 - RealIp (str) - 真实主机ip - Remark (str) - VIP备注 - SubnetId (str) - 子网id - Tag (str) - VIP所属业务组 - VIP (str) - 虚拟ip - VIPId (str) - 虚拟ip id - VPCId (str) - VPC id - Zone (str) - 地域

describe_vpc(req: Optional[dict] = None, **kwargs) → dict[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

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

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

describe_vpc_intercom(req: Optional[dict] = None, **kwargs) → dict[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 - AccountId (int) - 项目Id（数字） - DstRegion (str) - 所属地域 - Name (str) - VPC名字 - Network (list) - VPC的地址空间 - ProjectId (str) - 项目Id - Tag (str) - 业务组（未分组显示为 Default） - VPCId (str) - VPCId - VPCType (int) - vpc类型（1表示托管VPC，0表示公有云VPC）

describe_white_list_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

DescribeWhiteListResource - 展示NAT网关白名单资源列表

Request

ProjectId (str) - (Config) 项目id
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWIds (list) - (Required) NAT网关的Id
Limit (int) - 数据分页值, 默认为20
Offset (int) - 数据偏移量, 默认为0

Response

DataSet (list) - 见 NatGWWhitelistDataSet 模型定义
TotalCount (int) - 上述DataSet总数量

Response Model

DescribeWhiteListResourceObjectIPInfo - GwType (str) - natgw字符串 - PrivateIP (str) - 白名单资源的内网IP - ResourceId (str) - 白名单资源Id信息 - ResourceName (str) - 白名单资源名称 - ResourceType (str) - 白名单资源类型 - SubResourceId (str) - 资源绑定的虚拟网卡的实例ID - SubResourceName (str) - 资源绑定的虚拟网卡的实例名称 - SubResourceType (str) - 资源绑定的虚拟网卡的类型 - VPCId (str) - 白名单资源所属VPCId

NatGWWhitelistDataSet - IfOpen (int) - 白名单开关标记 - NATGWId (str) - NATGateWay Id - ObjectIPInfo (list) - 见 DescribeWhiteListResourceObjectIPInfo 模型定义

enable_white_list(req: Optional[dict] = None, **kwargs) → dict[source]¶

EnableWhiteList - 修改NAT网关白名单开关

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
IfOpen (int) - (Required) 白名单开关标记。0：关闭；1：开启。默认为0
NATGWId (str) - (Required) NAT网关Id

Response

get_available_resource_for_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetAvailableResourceForPolicy - 获取NAT网关可配置端口转发规则的资源信息

Request

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

Response

DataSet (list) - 见 GetAvailableResourceForPolicyDataSet 模型定义

Response Model

GetAvailableResourceForPolicyDataSet - PrivateIP (str) - 资源对应的内网Ip - ResourceId (str) - 资源的Id - ResourceType (str) - 资源类型。”uhost”：云主机； “upm”，物理云主机； “hadoophost”：hadoop节点； “fortresshost”：堡垒机： “udockhost”，容器

get_available_resource_for_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetAvailableResourceForSnatRule - 获取可用于添加snat规则（出口规则）的资源列表

Request

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

Response

Action (str) - 操作名称
DataSet (list) - 见 GetAvailableResourceForSnatRuleDataSet 模型定义
RetCode (str) - 返回值
TotalCount (int) - 总数

Response Model

GetAvailableResourceForSnatRuleDataSet - PrivateIP (str) - 资源内网IP - ResourceId (str) - 资源ID - ResourceName (str) - 资源名称 - ResourceType (str) - 资源类型 - SubnetworkId (str) - 资源所属VPC的ID - VPCId (str) - 资源所属子网的ID

get_available_resource_for_white_list(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetAvailableResourceForWhiteList - 获取NAT网关可添加白名单的资源

Request

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

Response

DataSet (list) - 见 GetAvailableResourceForWhiteListDataSet 模型定义
TotalCount (int) - 白名单资源列表的总的个数

Response Model

GetAvailableResourceForWhiteListDataSet - PrivateIP (str) - 资源的内网Ip - ResourceId (str) - 资源类型Id - ResourceName (str) - 资源名称 - ResourceType (str) - 资源类型。”uhost”：云主机； “upm”，物理云主机； “hadoophost”：hadoop节点； “fortresshost”：堡垒机： “udockhost”，容器 - SubResourceId (str) - 资源绑定的虚拟网卡的实例ID - SubResourceName (str) - 资源绑定的虚拟网卡的实例名称 - SubResourceType (str) - 资源绑定的虚拟网卡的实例类型 - SubnetworkId (str) - 资源所属子网Id - VPCId (str) - 资源所属VPCId

get_network_acl_target_resource(req: Optional[dict] = None, **kwargs) → dict[source]¶

GetNetworkAclTargetResource - 获取ACL规则应用目标列表

Request

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

Response

TargetResourceList (list) - 见 TargetResourceInfo 模型定义
TotalCount (int) - ACL规则应用目标资源总数

Response Model

TargetResourceInfo - PrivateIp (str) - 资源内网IP - ResourceId (str) - 资源ID - ResourceName (str) - 资源名称 - ResourceType (int) - 资源类型 - SubResourceId (str) - 资源绑定的虚拟网卡的ID - SubResourceName (str) - 资源绑定的虚拟网卡的名称 - SubResourceType (int) - 资源绑定虚拟网卡的类型 - SubnetworkId (str) - 子网ID

list_subnet_for_natgw(req: Optional[dict] = None, **kwargs) → dict[source]¶

ListSubnetForNATGW - 展示NAT网关可绑定的子网列表

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
VPCId (str) - NAT网关所属VPC Id。默认值为Default VPC Id

Response

DataSet (list) - 见 NatgwSubnetDataSet 模型定义

Response Model

NatgwSubnetDataSet - HasNATGW (bool) - 是否绑定NATGW - Netmask (str) - 掩码 - Subnet (str) - 子网网段 - SubnetId (str) - 子网id - SubnetName (str) - 子网名字

modify_route_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

ModifyRouteRule - 路由策略增、删、改

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
RouteRule (list) - (Required) 格式: RouteRuleId | 目的网段 | 下一跳类型（支持INSTANCE、VIP） | 下一跳 |优先级（保留字段，填写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

release_vip(req: Optional[dict] = None, **kwargs) → dict[source]¶

ReleaseVIP - 释放VIP资源

Request

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

Response

set_gw_default_export(req: Optional[dict] = None, **kwargs) → dict[source]¶

SetGwDefaultExport - 设置NAT网关的默认出口

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
ExportEipId (str) - NAT网关绑定的EIP Id。ExportIp和ExportEipId必填一个
ExportIp (str) - NAT网关绑定的EIP。ExportIp和ExportEipId必填一个

Response

update_natgw_policy(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateNATGWPolicy - 更新NAT网关端口转发规则

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
DstIP (str) - (Required) 目标IP。填写对饮的目标IP地址
DstPort (str) - (Required) 目标端口。可填写固定端口，也可填写端口范围。支持的端口范围为1-65535
NATGWId (str) - (Required) NAT网关Id
PolicyId (str) - (Required) 转发策略Id
Protocol (str) - (Required) 协议类型。枚举值为：TCP 、 UDP
SrcEIPId (str) - (Required) 源IP。填写对应的EIP Id
SrcPort (str) - (Required) 源端口。可填写固定端口，也可填写端口范围。支持的端口范围为1-6553
PolicyName (str) - 转发策略名称。默认为空

Response

update_natgw_subnet(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateNATGWSubnet - 更新NAT网关绑定的子网

Request

ProjectId (str) - (Config) 项目Id。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关Id
SubnetworkIds (list) - (Required) NAT网关绑定的子网Id

Response

update_network_acl(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateNetworkAcl - 更改ACL

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclId (str) - (Required) 需要更改的ACL ID
AclName (str) - (Required) Acl的名称
Description (str) - (Required) 描述

Response

update_network_acl_entry(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateNetworkAclEntry - 更新ACL的规则

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
AclId (str) - (Required) ACL的ID
CidrBlock (str) - (Required) IPv4段的CIDR表示
Direction (str) - (Required) 出向或者入向（“Ingress”, “Egress”)
EntryAction (str) - (Required) 规则的行为(“Accept”, “Reject”)
EntryId (str) - (Required) 需要更新的Entry Id
IpProtocol (str) - (Required) 针对的协议规则
PortRange (str) - (Required) 针对的端口范围
Priority (int) - (Required) Entry的优先级，对于同样的Direction来说，不能重复
Description (str) - 描述
TargetResourceIds (list) - 应用目标资源列表。默认为全部资源生效。TargetType为0时不用填写该值
TargetType (int) - 应用目标类型。0代表“子网内全部资源”， 1代表“子网内指定资源”。默认为0

Response

update_route_table_attribute(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateRouteTableAttribute - 更新路由表基本信息

Request

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

Response

update_snat_rule(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateSnatRule - 更新指定的出口规则（SNAT规则）

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
NATGWId (str) - (Required) NAT网关的ID，
SnatIp (str) - (Required) EIP的ip地址,例如106.75.xx.xx
SourceIp (str) - (Required) 需要出外网的私网IP地址，例如10.9.7.xx
Name (str) - snat名称，即出口规则名称

Response

update_subnet_attribute(req: Optional[dict] = None, **kwargs) → dict[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_vip_attribute(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateVIPAttribute - 更新VIP信息

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
VIPId (str) - (Required) 内网VIP的资源Id
Name (str) - 内网VIP的名称
Remark (str) - 内网VIP的备注
Tag (str) - 内网VIP所属的业务组

Response

update_vpc_network(req: Optional[dict] = None, **kwargs) → dict[source]¶

UpdateVPCNetwork - 更新VPC网段

Request

ProjectId (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。请参考 GetProjectList接口
Region (str) - (Config) 地域。参见地域和可用区列表
Network (list) - (Required) 需要保留的VPC网段。当前仅支持删除VPC网段，添加网段请参考 AddVPCNetwork
VPCId (str) - (Required) VPC的ID

Response

UCloud SDK Services¶

PathX¶

StepFlow¶

UAccount¶

UCDN¶

UDB¶

UDPN¶

UDisk¶

UHost¶

ULB¶

UMem¶

UNet¶

UPHost¶

USMS¶

VPC¶

Cube¶

IAM¶

IPSecVPN¶

ISMS¶

TiDB¶

UBill¶

UDDB¶

UDTS¶

UEC¶

UFS¶

UFile¶

UHub¶

UK8S¶

UNVS¶

UTSDB¶

UVMS¶

VPC¶

ucloud-sdk-python3

Navigation

Related Topics