获取VServer信息-DescribeVServer

获取ULB下的VServer的详细信息

VServerId 对应 CreateVServer 返回的 VServerId
或者 DescribeULB 返回的 ULBVServerSet 中的 VServerId

Request Parameters

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

Response Elements

Parameter name	Type	Description	Required
RetCode	int	操作返回码	Yes
Action	string	操作名称	Yes
TotalCount	int	满足条件的VServer总数	No
DataSet	array	VServer列表，每项参数详见 ULBVServerSet	No

ULBVServerSet

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

ULBSSLSet

Parameter name	Type	Description	Required
SSLId	string	SSL证书的Id	No
SSLName	string	SSL证书的名字	No
SSLType	string	SSL证书类型，暂时只有 Pem 一种类型	No
SSLContent	string	SSL证书的内容	No
CreateTime	int	SSL证书的创建时间	No
SSLBindedTargetSet	array	SSL证书绑定到的对象	No

SSLBindedTargetSet

Parameter name	Type	Description	Required
VServerId	string	SSL证书绑定到的VServer的资源ID	No
VServerName	string	对应的VServer的名字	No
ULBId	string	VServer 所属的ULB实例的资源ID	No
ULBName	string	ULB实例的名称	No

ULBPolicySet

Parameter name	Type	Description	Required
PolicyId	string	内容转发Id，默认内容转发类型下为空。	No
PolicyType	string	内容类型，枚举值：Custom → 客户自定义；Default → 默认内容转发	No
Type	string	内容转发匹配字段的类型，枚举值：Domain → 域名；Path → 路径；默认内容转发类型下为空	No
Match	string	内容转发匹配字段;默认内容转发类型下为空。	No
PolicyPriority	int	内容转发优先级，范围[1,9999]，数字越大优先级越高。默认内容转发规则下为0。	No
VServerId	string	所属VServerId	No
TotalCount	int	默认内容转发类型下返回当前rs总数	No
BackendSet	array	内容转发下rs的详细信息，参考PolicyBackendSet	No

PolicyBackendSet

Parameter name	Type	Description	Required
BackendId	string	所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关	No
ObjectId	string	后端资源的对象ID	No
Port	int	所添加的后端资源服务端口	No
PrivateIP	string	后端资源的内网IP	No
ResourceName	string	后端资源的实例名称	No

ULBBackendSet

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

Request Example

https://api.ucloud.cn/?Action=DescribeVServer
&Region=cn-bj2
&ProjectId=project-XXXXX
&ULBId=ulb-XXXXX
&Limit=LSQaCCYc
&Offset=OmWlbCEx

Response Example

{
    "TotalCount": 1,
    "DataSet": [
        {
            "ListenType": "RequestProxy",
            "VServerId": "vserver-XXX",
            "MetricIdSet": [
                {
                    "MetricId": "69538bf3-00bc-4385-85cc-XXXX",
                    "Type": "OuterMode"
                }
            ],
            "VServerName": "VServer",
            "CreateTime": 1529909432,
            "Protocol": "HTTP",
            "FrontendPort": 80,
            "Method": "Roundrobin",
            "PersistenceType": "None",
            "PersistenceInfo": "",
            "ClientTimeout": 60,
            "MonitorType": "Port",
            "Domain": "",
            "Path": "",
            "Status": 0,
            "SSLSet": [],
            "BackendSet": [
                {
                    "BackendId": "backend-XXX",
                    "ResourceType": "UHost",
                    "ResourceId": "uhost-XXXX",
                    "ResourceName": "test",
                    "PrivateIP": "10.25.XX.17",
                    "Port": 80,
                    "Enabled": 1,
                    "SubnetId": "subnet-XXXXX",
                    "Status": 0
                }
            ],
            "PolicySet": [
                {
                    "PolicyId": "",
                    "PolicyType": "Default",
                    "Type": "",
                    "Match": "",
                    "PolicyPriority": 0,
                    "VServerId": "vserver-XXXXX",
                    "TotalCount": 1,
                    "BackendSet": [
                        {
                            "BackendId": "backend-XXXXX",
                            "ResourceName": "test",
                            "ObjectId": "b47f082b-684f-4d5c-8dc4-XXXX",
                            "PrivateIP": "10.25.XX.17",
                            "Port": 80
                        }
                    ]
                }
            ]
        }
    ],
    "RetCode": 0,
    "Action": "DescribeVServerResponse"
}

文档中心

获取VServer信息-DescribeVServer

Request Parameters

Response Elements

ULBVServerSet

ULBSSLSet

SSLBindedTargetSet

ULBPolicySet

PolicyBackendSet

ULBBackendSet

Request Example

Response Example