def describe_vserver(self, req=None, **kwargs):
""" DescribeVServer - 获取ULB下的VServer的详细信息
:param ProjectId: (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](../summary/get_project_list.html)
:param Region: (Config) 地域。 参见 [地域和可用区列表](../summary/regionlist.html)
:param ULBId: (Required) 负载均衡实例的Id
:param Limit: (Optional) 数据分页值
:param Offset: (Optional) 数据偏移量
:param VServerId: (Optional) VServer实例的Id；若指定则返回指定的VServer实例的信息； 若不指定则返回当前负载均衡实例下所有VServer的信息
"""
d = {"ProjectId": self.config.project_id, "Region": self.config.region}
req and d.update(req)
d = apis.DescribeVServerRequestSchema().dumps(d)
resp = self.invoke("DescribeVServer", d, **kwargs)
return apis.DescribeVServerResponseSchema().loads(resp)
def describe_vserver(
self, req: typing.Optional[dict] = None, **kwargs
) -> dict:
"""DescribeVServer - 获取ULB下的VServer的详细信息
**Request**
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list.html>`_
- **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist.html>`_
- **ULBId** (str) - (Required) 负载均衡实例的Id
- **Limit** (int) - 数据分页值
- **Offset** (int) - 数据偏移量
- **VServerId** (str) - VServer实例的Id；若指定则返回指定的VServer实例的信息； 若不指定则返回当前负载均衡实例下所有VServer的信息
**Response**
- **DataSet** (list) - 见 **ULBVServerSet** 模型定义
- **TotalCount** (int) - 满足条件的VServer总数
**Response Model**
**PolicyBackendSet**
- **BackendId** (str) - 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关
- **ObjectId** (str) - 后端资源的对象ID
- **Port** (int) - 所添加的后端资源服务端口
- **PrivateIP** (str) - 后端资源的内网IP
- **ResourceName** (str) - 后端资源的实例名称
**ULBSSLSet**
- **HashValue** (str) -
- **SSLId** (str) - SSL证书的Id
- **SSLName** (str) - SSL证书的名字
**ULBPolicySet**
- **BackendSet** (list) - 见 **PolicyBackendSet** 模型定义
- **Match** (str) - 内容转发匹配字段;默认内容转发类型下为空。
- **PolicyId** (str) - 内容转发Id，默认内容转发类型下为空。
- **PolicyPriority** (int) - 内容转发优先级，范围[1,9999]，数字越大优先级越高。默认内容转发规则下为0。
- **PolicyType** (str) - 内容类型，枚举值：Custom -> 客户自定义；Default -> 默认内容转发
- **TotalCount** (int) - 默认内容转发类型下返回当前rs总数
- **Type** (str) - 内容转发匹配字段的类型，枚举值：Domain -> 域名；Path -> 路径； 默认内容转发类型下为空
- **VServerId** (str) - 所属VServerId
**ULBBackendSet**
- **BackendId** (str) - 后端资源实例的Id
- **Enabled** (int) - 后端提供服务的实例启用与否，枚举值：0 禁用 1 启用
- **Port** (int) - 后端提供服务的端口
- **PrivateIP** (str) - 后端提供服务的内网IP
- **ResourceId** (str) - 资源实例的资源Id
- **ResourceName** (str) - 资源实例的资源名称
- **ResourceType** (str) - 资源实例的类型
- **Status** (int) - 后端提供服务的实例运行状态，枚举值：0健康检查健康状态 1 健康检查异常
- **SubResourceId** (str) - 资源绑定的虚拟网卡实例的资源Id
- **SubResourceName** (str) - 资源绑定的虚拟网卡实例的资源名称
- **SubResourceType** (str) - 资源绑定的虚拟网卡实例的类型
- **SubnetId** (str) - 后端提供服务的资源所在的子网的ID
- **Weight** (int) -
**ULBVServerSet**
- **BackendSet** (list) - 见 **ULBBackendSet** 模型定义
- **ClientTimeout** (int) - 空闲连接的回收时间，单位：秒。
- **Domain** (str) - 根据MonitorType确认； 当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查域名
- **FrontendPort** (int) - VServer服务端口
- **ListenType** (str) - 监听器类型，枚举值为: RequestProxy -> 请求代理；PacketsTransmit -> 报文转发
- **Method** (str) - VServer负载均衡的模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）。
- **MonitorType** (str) - 健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；
- **Path** (str) - 根据MonitorType确认； 当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查路径
- **PersistenceInfo** (str) - 根据PersistenceType确定： None或ServerInsert，此字段为空； UserDefined，此字段展示用户自定义会话string。
- **PersistenceType** (str) - VServer会话保持方式。枚举值为： None -> 关闭会话保持； ServerInsert -> 自动生成； UserDefined -> 用户自定义。
- **PolicySet** (list) - 见 **ULBPolicySet** 模型定义
- **Protocol** (str) - VServer实例的协议。 枚举值为：HTTP，TCP，UDP，HTTPS。
- **SSLSet** (list) - 见 **ULBSSLSet** 模型定义
- **Status** (int) - VServer的运行状态。枚举值： 0 -> rs全部运行正常;1 -> rs全部运行异常；2 -> rs部分运行异常。
- **VServerId** (str) - VServer实例的Id
- **VServerName** (str) - VServer实例的名字
"""
# build request
d = {"ProjectId": self.config.project_id, "Region": self.config.region}
req and d.update(req)
d = apis.DescribeVServerRequestSchema().dumps(d)
resp = self.invoke("DescribeVServer", d, **kwargs)
return apis.DescribeVServerResponseSchema().loads(resp)
def describe_vserver(self,
req: typing.Optional[dict] = None,
**kwargs) -> dict:
"""DescribeVServer - 获取ULB下的VServer的详细信息
**Request**
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目，子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
- **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
- **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的名字
"""
# build request
d = {
"ProjectId": self.config.project_id,
"Region": self.config.region,
}
req and d.update(req)
d = apis.DescribeVServerRequestSchema().dumps(d)
resp = self.invoke("DescribeVServer", d, **kwargs)
return apis.DescribeVServerResponseSchema().loads(resp)