diff --git a/ucloud/services/udb/client.py b/ucloud/services/udb/client.py index 6202acd..aa54f86 100644 --- a/ucloud/services/udb/client.py +++ b/ucloud/services/udb/client.py @@ -835,6 +835,20 @@ def describe_mongo_db_sharded_cluster( **Response Model** + **MongoDBShardedClusterSet** + - **CreateTime** (int) - + - **DBId** (str) - + - **DBTypeId** (str) - + - **MongosCount** (int) - + - **Name** (str) - + - **ShardsrvCount** (int) - + - **SubnetId** (str) - + - **Tag** (str) - + - **VPCId** (str) - + - **VirtualIPs** (list) - + - **Zone** (str) - + + **UFileDataSet** - **Bucket** (str) - - **TokenID** (str) - @@ -942,20 +956,6 @@ def describe_mongo_db_sharded_cluster( - **Zone** (str) - - **MongoDBShardedClusterSet** - - **CreateTime** (int) - - - **DBId** (str) - - - **DBTypeId** (str) - - - **MongosCount** (int) - - - **Name** (str) - - - **ShardsrvCount** (int) - - - **SubnetId** (str) - - - **Tag** (str) - - - **VPCId** (str) - - - **VirtualIPs** (list) - - - **Zone** (str) - - - """ # build request d = { @@ -1224,11 +1224,6 @@ def describe_udb_instance( **Response Model** - **UFileDataSet** - - **Bucket** (str) - bucket名称 - - **TokenID** (str) - Ufile的令牌tokenid - - **UDBSlaveInstanceSet** - **AdminUser** (str) - 管理员帐户名,默认root - **BackupBeginTime** (int) - 备份策略,不可修改,开始时间,单位小时计,默认3点 @@ -1274,6 +1269,11 @@ def describe_udb_instance( - **Zone** (str) - 可用区 + **UFileDataSet** + - **Bucket** (str) - bucket名称 + - **TokenID** (str) - Ufile的令牌tokenid + + **UDBInstanceSet** - **AdminUser** (str) - 管理员帐户名,默认root - **AutoRenew** (int) - 0 不自动续费, 1 自动续费 @@ -1976,6 +1976,56 @@ def fetch_udb_instance_earliest_recover_time( resp ) + def get_udb_access_info( + self, req: typing.Optional[dict] = None, **kwargs + ) -> dict: + """GetUDBAccessInfo - 查询 UDB 实例的内网与外网访问信息,包含外网地址端口、带宽、白名单,以及内网 VPC、子网、内网 IP、内网域名与端口1 + + **Request** + + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目,子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **DBId** (str) - (Required) 实例ID + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + + **Response** + + - **ExternalInfo** (list) - 见 **ExternalInfo** 模型定义 + - **Message** (str) - 错误信息 + - **PrivateInfo** (list) - 见 **PrivateInfo** 模型定义 + + **Response Model** + + **PrivateInfo** + - **PrivateDomain** (str) - 实例的内网域名;未开通内网域名时为空字符串 + - **PrivateDomainStatus** (str) - 实例内网服务端口 + - **PrivateIP** (str) - 实例内网服务地址(VIP) + - **PrivatePort** (int) - 内网域名状态,字符串枚举,取值与 Status 同源;未开通内网域名时返回NetworkConnectionDisabled + - **SubnetId** (str) - 实例内网所在的子网 ID + - **VPCId** (str) - 实例内网所在的 VPC ID + + + **ExternalInfo** + - **Bindwidth** (int) - 外网带宽,单位 Mbps,取自 EIP 带宽;无 EIP 时为 0 + - **ExternalAddress** (str) - 外网访问地址;未开通外网访问时为空字符串 + - **ExternalPort** (int) - 外网访问端口;未开通时为 0 + - **Status** (str) - 外网访问状态,字符串枚举,取值见下表 + - **Support** (int) - 实例是否支持外网访问能力:1 支持;当前实现恒返回 1 + - **WhiteList** (str) - 外网访问白名单,多个 IP 以逗号分隔,取自 NLB 白名单 + + + """ + # build request + d = { + "ProjectId": self.config.project_id, + "Region": self.config.region, + } + req and d.update(req) + d = apis.GetUDBAccessInfoRequestSchema().dumps(d) + + resp = self.invoke("GetUDBAccessInfo", d, **kwargs) + return apis.GetUDBAccessInfoResponseSchema().loads(resp) + def get_udb_client_conn_num( self, req: typing.Optional[dict] = None, **kwargs ) -> dict: diff --git a/ucloud/services/udb/schemas/apis.py b/ucloud/services/udb/schemas/apis.py index 0380168..42f0872 100644 --- a/ucloud/services/udb/schemas/apis.py +++ b/ucloud/services/udb/schemas/apis.py @@ -1620,6 +1620,38 @@ class FetchUDBInstanceEarliestRecoverTimeResponseSchema(schema.ResponseSchema): } +""" +API: GetUDBAccessInfo + +查询 UDB 实例的内网与外网访问信息,包含外网地址端口、带宽、白名单,以及内网 VPC、子网、内网 IP、内网域名与端口1 +""" + + +class GetUDBAccessInfoRequestSchema(schema.RequestSchema): + """GetUDBAccessInfo - 查询 UDB 实例的内网与外网访问信息,包含外网地址端口、带宽、白名单,以及内网 VPC、子网、内网 IP、内网域名与端口1""" + + fields = { + "DBId": fields.Str(required=True, dump_to="DBId"), + "ProjectId": fields.Str(required=True, dump_to="ProjectId"), + "Region": fields.Str(required=True, dump_to="Region"), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class GetUDBAccessInfoResponseSchema(schema.ResponseSchema): + """GetUDBAccessInfo - 查询 UDB 实例的内网与外网访问信息,包含外网地址端口、带宽、白名单,以及内网 VPC、子网、内网 IP、内网域名与端口1""" + + fields = { + "ExternalInfo": fields.List( + models.ExternalInfoSchema(), required=True, load_from="ExternalInfo" + ), + "Message": fields.Str(required=True, load_from="Message"), + "PrivateInfo": fields.List( + models.PrivateInfoSchema(), required=True, load_from="PrivateInfo" + ), + } + + """ API: GetUDBClientConnNum diff --git a/ucloud/services/udb/schemas/models.py b/ucloud/services/udb/schemas/models.py index 1fe912a..4cadd9b 100644 --- a/ucloud/services/udb/schemas/models.py +++ b/ucloud/services/udb/schemas/models.py @@ -3,15 +3,6 @@ from ucloud.core.typesystem import schema, fields -class UFileDataSetSchema(schema.ResponseSchema): - """UFileDataSet - 增加ufile的描述""" - - fields = { - "Bucket": fields.Str(required=False, load_from="Bucket"), - "TokenID": fields.Str(required=False, load_from="TokenID"), - } - - class UDBSlaveInstanceSetSchema(schema.ResponseSchema): """UDBSlaveInstanceSet - DescribeUDBSlaveInstance""" @@ -82,6 +73,15 @@ class UDBSlaveInstanceSetSchema(schema.ResponseSchema): } +class UFileDataSetSchema(schema.ResponseSchema): + """UFileDataSet - 增加ufile的描述""" + + fields = { + "Bucket": fields.Str(required=False, load_from="Bucket"), + "TokenID": fields.Str(required=False, load_from="TokenID"), + } + + class UDBInstanceSetSchema(schema.ResponseSchema): """UDBInstanceSet - DescribeUDBInstance""" @@ -308,6 +308,36 @@ class UDBTypeSetSchema(schema.ResponseSchema): } +class PrivateInfoSchema(schema.ResponseSchema): + """PrivateInfo - 实例内网访问信息,含 VPC、子网、内网 IP、内网域名与端口""" + + fields = { + "PrivateDomain": fields.Str(required=False, load_from="PrivateDomain"), + "PrivateDomainStatus": fields.Str( + required=False, load_from="PrivateDomainStatus" + ), + "PrivateIP": fields.Str(required=False, load_from="PrivateIP"), + "PrivatePort": fields.Int(required=False, load_from="PrivatePort"), + "SubnetId": fields.Str(required=False, load_from="SubnetId"), + "VPCId": fields.Str(required=False, load_from="VPCId"), + } + + +class ExternalInfoSchema(schema.ResponseSchema): + """ExternalInfo - 实例外网访问信息,含状态、地址、端口、带宽与白名单""" + + fields = { + "Bindwidth": fields.Int(required=False, load_from="Bindwidth"), + "ExternalAddress": fields.Str( + required=False, load_from="ExternalAddress" + ), + "ExternalPort": fields.Int(required=False, load_from="ExternalPort"), + "Status": fields.Str(required=False, load_from="Status"), + "Support": fields.Int(required=False, load_from="Support"), + "WhiteList": fields.Str(required=False, load_from="WhiteList"), + } + + class ConnNumMapSchema(schema.ResponseSchema): """ConnNumMap - db实例ip和连接数信息""" diff --git a/ucloud/services/udbproxy/client.py b/ucloud/services/udbproxy/client.py index fa673b3..0972ac5 100644 --- a/ucloud/services/udbproxy/client.py +++ b/ucloud/services/udbproxy/client.py @@ -15,6 +15,80 @@ def __init__( config, transport, middleware, logger ) + def describe_udb_proxy( + self, req: typing.Optional[dict] = None, **kwargs + ) -> dict: + """DescribeUDBProxy - 获取UDB代理服务详细信息 + + **Request** + + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目,子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **UDBProxyID** (str) - (Required) 读写分离ID + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + + **Response** + + - **CPUCores** (int) - cpu核数 + - **CreateTime** (int) - 创建时间 + - **DelayThreshold** (int) - 延迟阈值(单位s) + - **EnableTransSplit** (int) - 是否启用事务拆分(1:启用事务拆分,2:关闭事务拆分) + - **InstanceVersion** (str) - 实例版本 + - **MaxConnection** (int) - UDB代理服务最大连接数 + - **Memory** (int) - 内存 + - **ModifyTime** (int) - 修改时间 + - **Name** (str) - 名称 + - **NodeCount** (int) - 集群实例节点数 + - **Nodes** (list) - 见 **Node** 模型定义 + - **PrivateDomainInfo** (dict) - 见 **PrivateDomainInfo** 模型定义 + - **ReadWeightMode** (int) - 读权重模式:1-主节点模式;2-节点均衡模式;3-从节点均衡(排除主节点);5-用户自定义模式 + - **SQLLimitCount** (int) - sql限流数量 + - **SQLRouterCount** (int) - sql路由数量 + - **State** (str) - 状态 + - **UDBProxyID** (str) - UDBProxy实例ID + - **UDBProxyIP** (str) - UDB代理服务IP + - **UDBProxyPort** (int) - UDB代理服务端口 + - **UDBReplicas** (list) - 见 **Replica** 模型定义 + - **ZoneId** (int) - 可用区id + + **Response Model** + + **Replica** + - **CreateTime** (int) - 创建时间 + - **ID** (str) - 数据库ID + - **IP** (str) - 数据库IP + - **JoinState** (bool) - 是否加入代理服务(true:加入,false:未加入) + - **ModifyTime** (int) - 修改时间 + - **Name** (str) - 数据库名称 + - **Port** (int) - 数据库服务端口 + - **ReadWeight** (int) - 读权重 + - **Role** (str) - 角色[master-主库,slave-从库] + - **State** (str) - 状态 + + + **PrivateDomainInfo** + - **EnableConnectToDB** (int) - 内网域名指向的数据源:1 指向主库(可直连数据库),2 指向代理(经 UDBProxy访问);未开通时返回 2 + - **EnablePrivateDomain** (int) - 内网域名是否已开启:1 已开启,2 已关闭;未开通内网域名时返回 2 + - **PrivateDomain** (str) - 实例的内网域名地址,形如 xxx.ucloudcs.com;未开通内网域名时为空字符串 + + + **Node** + - **ID** (str) - 服务节点id + - **State** (str) - 服务节点状态 + + + """ + # build request + d = { + "ProjectId": self.config.project_id, + "Region": self.config.region, + } + req and d.update(req) + d = apis.DescribeUDBProxyRequestSchema().dumps(d) + + resp = self.invoke("DescribeUDBProxy", d, **kwargs) + return apis.DescribeUDBProxyResponseSchema().loads(resp) + def list_udb_proxy_client( self, req: typing.Optional[dict] = None, **kwargs ) -> dict: @@ -34,14 +108,8 @@ def list_udb_proxy_client( **Response Model** - **NodeClientInfo** - - **ID** (str) - 代理节点ID - - **IP** (str) - 代理节点IP - - **Records** (list) - 见 **ProxyProcesslist** 模型定义 - - **ProxyProcesslist** - - **ClientHost** (str) - 代理连接DB地址 + - **ClientHost** (str) - 客户端来源IP地址 - **Command** (str) - 显示当前连接的执行的命令 - **DB** (str) - 当前执行的命令是在哪一个数据库上。如果没有指定数据库,则该值为 NULL - **DBID** (str) - 数据库资源ID @@ -54,6 +122,12 @@ def list_udb_proxy_client( - **User** (str) - 启动这个线程的用户 + **NodeClientInfo** + - **ID** (str) - 代理节点ID + - **IP** (str) - 代理节点IP + - **Records** (list) - 见 **ProxyProcesslist** 模型定义 + + """ # build request d = { @@ -65,3 +139,56 @@ def list_udb_proxy_client( resp = self.invoke("ListUDBProxyClient", d, **kwargs) return apis.ListUDBProxyClientResponseSchema().loads(resp) + + def list_udb_proxy_instance_by_db( + self, req: typing.Optional[dict] = None, **kwargs + ) -> dict: + """ListUDBProxyInstanceByDB - 查询DB启用代理数据 + + **Request** + + - **ProjectId** (str) - (Config) 项目ID。不填写为默认项目,子帐号必须填写。 请参考 `GetProjectList接口 `_ + - **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 `_ + - **DBID** (str) - (Required) 数据库DB资源ID + - **Zone** (str) - (Required) 可用区。参见 `可用区列表 `_ + + **Response** + + - **Message** (str) - 错误码 + - **UDBProxyBaseItems** (list) - 见 **UDBProxyBaseItem** 模型定义 + + **Response Model** + + **BaseDBData** + - **ID** (str) - 数据库ID + - **Name** (str) - 数据库名称 + - **ReadWeight** (int) - 权重 + + + **UDBProxyBaseItem** + - **BaseDBDataArr** (list) - 见 **BaseDBData** 模型定义 + - **CPUCores** (int) - 单个代理节点CPU核数 + - **CreateTime** (int) - 创建时间 + - **ID** (str) - 代理ID + - **IP** (str) - 代理IP + - **InstanceVersion** (str) - 实例版本 + - **Memory** (int) - 单个代理内存 + - **Name** (str) - 代理名称 + - **NodeCount** (int) - 代理节点数 + - **Port** (int) - 代理端口 + - **ReadWeightMode** (int) - 读权重模式:1-主节点模式;2-节点均衡模式;3-从节点均衡(排除主节点);5-用户自定义模式 + - **State** (str) - 状态 + - **ZoneID** (int) - 可用区ID + + + """ + # build request + d = { + "ProjectId": self.config.project_id, + "Region": self.config.region, + } + req and d.update(req) + d = apis.ListUDBProxyInstanceByDBRequestSchema().dumps(d) + + resp = self.invoke("ListUDBProxyInstanceByDB", d, **kwargs) + return apis.ListUDBProxyInstanceByDBResponseSchema().loads(resp) diff --git a/ucloud/services/udbproxy/schemas/apis.py b/ucloud/services/udbproxy/schemas/apis.py index 6eb145c..6004e8e 100644 --- a/ucloud/services/udbproxy/schemas/apis.py +++ b/ucloud/services/udbproxy/schemas/apis.py @@ -7,6 +7,62 @@ """ +""" +API: DescribeUDBProxy + +获取UDB代理服务详细信息 +""" + + +class DescribeUDBProxyRequestSchema(schema.RequestSchema): + """DescribeUDBProxy - 获取UDB代理服务详细信息""" + + fields = { + "ProjectId": fields.Str(required=False, dump_to="ProjectId"), + "Region": fields.Str(required=True, dump_to="Region"), + "UDBProxyID": fields.Str(required=True, dump_to="UDBProxyID"), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class DescribeUDBProxyResponseSchema(schema.ResponseSchema): + """DescribeUDBProxy - 获取UDB代理服务详细信息""" + + fields = { + "CPUCores": fields.Int(required=True, load_from="CPUCores"), + "CreateTime": fields.Int(required=True, load_from="CreateTime"), + "DelayThreshold": fields.Int(required=True, load_from="DelayThreshold"), + "EnableTransSplit": fields.Int( + required=False, load_from="EnableTransSplit" + ), + "InstanceVersion": fields.Str( + required=False, load_from="InstanceVersion" + ), + "MaxConnection": fields.Int(required=True, load_from="MaxConnection"), + "Memory": fields.Int(required=True, load_from="Memory"), + "ModifyTime": fields.Int(required=True, load_from="ModifyTime"), + "Name": fields.Str(required=True, load_from="Name"), + "NodeCount": fields.Int(required=True, load_from="NodeCount"), + "Nodes": fields.List( + models.NodeSchema(), required=True, load_from="Nodes" + ), + "PrivateDomainInfo": models.PrivateDomainInfoSchema(), + "ReadWeightMode": fields.Int(required=True, load_from="ReadWeightMode"), + "SQLLimitCount": fields.Int(required=False, load_from="SQLLimitCount"), + "SQLRouterCount": fields.Int( + required=False, load_from="SQLRouterCount" + ), + "State": fields.Str(required=True, load_from="State"), + "UDBProxyID": fields.Str(required=True, load_from="UDBProxyID"), + "UDBProxyIP": fields.Str(required=True, load_from="UDBProxyIP"), + "UDBProxyPort": fields.Int(required=True, load_from="UDBProxyPort"), + "UDBReplicas": fields.List( + models.ReplicaSchema(), required=True, load_from="UDBReplicas" + ), + "ZoneId": fields.Int(required=True, load_from="ZoneId"), + } + + """ API: ListUDBProxyClient @@ -36,3 +92,34 @@ class ListUDBProxyClientResponseSchema(schema.ResponseSchema): ), "UDBProxyID": fields.Str(required=True, load_from="UDBProxyID"), } + + +""" +API: ListUDBProxyInstanceByDB + +查询DB启用代理数据 +""" + + +class ListUDBProxyInstanceByDBRequestSchema(schema.RequestSchema): + """ListUDBProxyInstanceByDB - 查询DB启用代理数据""" + + fields = { + "DBID": fields.Str(required=True, dump_to="DBID"), + "ProjectId": fields.Str(required=False, dump_to="ProjectId"), + "Region": fields.Str(required=True, dump_to="Region"), + "Zone": fields.Str(required=True, dump_to="Zone"), + } + + +class ListUDBProxyInstanceByDBResponseSchema(schema.ResponseSchema): + """ListUDBProxyInstanceByDB - 查询DB启用代理数据""" + + fields = { + "Message": fields.Str(required=False, load_from="Message"), + "UDBProxyBaseItems": fields.List( + models.UDBProxyBaseItemSchema(), + required=True, + load_from="UDBProxyBaseItems", + ), + } diff --git a/ucloud/services/udbproxy/schemas/models.py b/ucloud/services/udbproxy/schemas/models.py index a3d79e8..e4f4c4d 100644 --- a/ucloud/services/udbproxy/schemas/models.py +++ b/ucloud/services/udbproxy/schemas/models.py @@ -3,21 +3,61 @@ from ucloud.core.typesystem import schema, fields -class ProxyProcesslistSchema(schema.ResponseSchema): - """ProxyProcesslist - 连接代理信息""" +class NodeSchema(schema.ResponseSchema): + """Node - UDB代理服务节点数据""" fields = { - "ClientHost": fields.Str(required=True, load_from="ClientHost"), - "Command": fields.Str(required=True, load_from="Command"), - "DB": fields.Str(required=True, load_from="DB"), - "DBID": fields.Str(required=True, load_from="DBID"), - "Host": fields.Str(required=True, load_from="Host"), - "ID": fields.Int(required=True, load_from="ID"), - "Info": fields.Str(required=True, load_from="Info"), + "ID": fields.Str(required=True, load_from="ID"), + "State": fields.Str(required=True, load_from="State"), + } + + +class ReplicaSchema(schema.ResponseSchema): + """Replica - UDB数据""" + + fields = { + "CreateTime": fields.Int(required=True, load_from="CreateTime"), + "ID": fields.Str(required=True, load_from="ID"), + "IP": fields.Str(required=True, load_from="IP"), + "JoinState": fields.Bool(required=True, load_from="JoinState"), + "ModifyTime": fields.Int(required=True, load_from="ModifyTime"), + "Name": fields.Str(required=True, load_from="Name"), + "Port": fields.Int(required=True, load_from="Port"), + "ReadWeight": fields.Int(required=True, load_from="ReadWeight"), "Role": fields.Str(required=True, load_from="Role"), "State": fields.Str(required=True, load_from="State"), - "Time": fields.Int(required=True, load_from="Time"), - "User": fields.Str(required=True, load_from="User"), + } + + +class PrivateDomainInfoSchema(schema.ResponseSchema): + """PrivateDomainInfo - 代理实例的内网域名及其开关状态,含域名地址、域名开关、域名数据源指向""" + + fields = { + "EnableConnectToDB": fields.Int( + required=False, load_from="EnableConnectToDB" + ), + "EnablePrivateDomain": fields.Int( + required=False, load_from="EnablePrivateDomain" + ), + "PrivateDomain": fields.Str(required=False, load_from="PrivateDomain"), + } + + +class ProxyProcesslistSchema(schema.ResponseSchema): + """ProxyProcesslist - 连接代理信息""" + + fields = { + "ClientHost": fields.Str(required=False, load_from="ClientHost"), + "Command": fields.Str(required=False, load_from="Command"), + "DB": fields.Str(required=False, load_from="DB"), + "DBID": fields.Str(required=False, load_from="DBID"), + "Host": fields.Str(required=False, load_from="Host"), + "ID": fields.Int(required=False, load_from="ID"), + "Info": fields.Str(required=False, load_from="Info"), + "Role": fields.Str(required=False, load_from="Role"), + "State": fields.Str(required=False, load_from="State"), + "Time": fields.Int(required=False, load_from="Time"), + "User": fields.Str(required=False, load_from="User"), } @@ -29,3 +69,35 @@ class NodeClientInfoSchema(schema.ResponseSchema): "IP": fields.Str(required=False, load_from="IP"), "Records": fields.List(ProxyProcesslistSchema()), } + + +class BaseDBDataSchema(schema.ResponseSchema): + """BaseDBData - 加入代理DB基础信息""" + + fields = { + "ID": fields.Str(required=False, load_from="ID"), + "Name": fields.Str(required=False, load_from="Name"), + "ReadWeight": fields.Int(required=False, load_from="ReadWeight"), + } + + +class UDBProxyBaseItemSchema(schema.ResponseSchema): + """UDBProxyBaseItem - 代理列表基础信息""" + + fields = { + "BaseDBDataArr": fields.List(BaseDBDataSchema()), + "CPUCores": fields.Int(required=False, load_from="CPUCores"), + "CreateTime": fields.Int(required=True, load_from="CreateTime"), + "ID": fields.Str(required=False, load_from="ID"), + "IP": fields.Str(required=False, load_from="IP"), + "InstanceVersion": fields.Str( + required=False, load_from="InstanceVersion" + ), + "Memory": fields.Int(required=False, load_from="Memory"), + "Name": fields.Str(required=False, load_from="Name"), + "NodeCount": fields.Int(required=False, load_from="NodeCount"), + "Port": fields.Int(required=False, load_from="Port"), + "ReadWeightMode": fields.Int(required=True, load_from="ReadWeightMode"), + "State": fields.Str(required=False, load_from="State"), + "ZoneID": fields.Int(required=False, load_from="ZoneID"), + } diff --git a/ucloud/version.py b/ucloud/version.py index 8219c9e..7898e41 100644 --- a/ucloud/version.py +++ b/ucloud/version.py @@ -1 +1 @@ -version = "0.11.160" +version = "0.11.161"