Skip to Content
负载均衡 ULB ALB获取CLB下的VServer信息 - DescribeVServer

获取CLB下的VServer信息 - DescribeVServer

简介

获取CLB下的VServer的详细信息

ℹ️ VServerId 对应 CreateVServer 返回的 VServerId或者 DescribeULB 返回的 ULBVServerSet 中的 VServerId，是传统型负载均衡监听器的Id

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 DescribeVServerYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口Yes
ULBIdstring传统型负载均衡实例的IdNo
VServerIdstringCLB下的VServer实例的Id；若指定则返回指定的VServer实例的信息； 若不指定则返回当前传统型负载均衡实例下所有VServer的信息No
Limitint数据分页值No
Offsetint数据偏移量No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
TotalCountint满足条件的VServer总数No
DataSetarray[ULBVServerSet]VServer列表，每项参数详见 ULBVServerSetNo

数据模型

ULBVServerSet

字段名类型描述信息必填
MonitorTypestring健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；Ping -> Ping探测， Customize -> UDP检查

请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path; 报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize		Yes
PersistenceTypestringVServer会话保持方式。枚举值为： None -> 关闭会话保持； ServerInsert -> 自动生成； UserDefined -> 用户自定义。Yes
ULBIdstring负载均衡实例的IdNo
Domainstring根据MonitorType确认； 当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查域名No
Pathstring根据MonitorType确认； 当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查路径No
RequestMsgstring根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文No
ResponseMsgstring根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文No
VServerIdstringVServer实例的IdNo
VServerNamestringVServer实例的名字No
ProtocolstringVServer实例的协议。 枚举值为：HTTP，TCP，UDP，HTTPS。No
FrontendPortintVServer服务端口No
MethodstringVServer负载均衡的模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）。No
PersistenceInfostring根据PersistenceType确定： None或ServerInsert，此字段为空； UserDefined，此字段展示用户自定义会话string。No
ClientTimeoutint空闲连接的回收时间，单位：秒。No
StatusintVServer的运行状态。枚举值： 0 -> rs全部运行正常;1 -> rs全部运行异常；2 -> rs部分运行异常。No
SSLSetarray[ULBSSLSet]VServer绑定的SSL证书信息，具体结构见下方 ULBSSLSet。No
BackendSetarray[ULBBackendSet]后端资源信息列表，具体结构见下方 ULBBackendSetNo
ListenTypestring监听器类型，枚举值为: RequestProxy -> 请求代理；PacketsTransmit -> 报文转发No
PolicySetarray[ULBPolicySet]内容转发信息列表，具体结构见下方 ULBPolicySetNo
EnableCompressionint数据压缩开关，0:关闭 1:开启No
SecurityPolicyBindSecurityPolicyVServer绑定的安全策略,具体结构见BindSecurityPolicyNo
ForwardPortint重定向端口，取值范围[0-65535]；默认值为0，代表关闭；仅HTTP协议支持开启重定向功能No
EnableHTTP2int0:关闭 1:开启，用于开启http2功能；默认值为0No

ULBSSLSet

字段名类型描述信息必填
SSLIdstringSSL证书的IdNo
SSLNamestringSSL证书的名字No
SSLTypestringSSL证书类型，暂时只有 Pem 一种类型No
SSLContentstringSSL证书的内容No
CreateTimeintSSL证书的创建时间No
HashValuestringSSL证书的HASH值No
BindedTargetSetarray[SSLBindedTargetSet]SSL证书绑定到的对象No
SSLSourceintSSL证书来源，SSL证书来源，0代表证书来自于ULB平台，1代表证书来自于USSL平台No
USSLIdstringUSSL证书平台的编号,只有当SSLSource为1时才出现No
DomainsstringSSL证书平台的域名，多域名时，不展示扩展域名No
NotBeforeint证书颁发时间No
NotAfterint证书过期时间No

ULBBackendSet

字段名类型描述信息必填
BackendIdstring后端资源实例的IdNo
ResourceTypestring资源实例的类型No
ResourceIdstring资源实例的资源IdNo
ResourceNamestring资源实例的资源名称No
SubResourceTypestring资源绑定的虚拟网卡实例的类型No
SubResourceIdstring资源绑定的虚拟网卡实例的资源IdNo
SubResourceNamestring资源绑定的虚拟网卡实例的资源名称No
PrivateIPstring后端提供服务的内网IPNo
Portint后端提供服务的端口No
Enabledint后端提供服务的实例启用与否，枚举值：0 禁用 1 启用No
Statusint后端提供服务的实例运行状态，枚举值：0健康检查健康状态 1 健康检查异常No
SubnetIdstring后端提供服务的资源所在的子网的IDNo
IsBackupint是否为backup，只有当vserver的Backup属性为1时才会有此字段，说明：

0：主rs
1：备rs		No
Weightint后端RS权重（在加权轮询算法下有效）No
VPCIdstring后端服务器所在的VPCNo

ULBPolicySet

字段名类型描述信息必填
DomainMatchModestring内容转发规则中域名的匹配方式。枚举值：Regular，正则；Wildcard，泛域名No
PolicyIdstring内容转发Id，默认内容转发类型下为空。No
PolicyTypestring内容类型，枚举值：Custom -> 客户自定义；Default -> 默认内容转发No
Typestring内容转发匹配字段的类型，枚举值：Domain -> 域名；Path -> 路径； 默认内容转发类型下为空No
Matchstring内容转发匹配字段;默认内容转发类型下为空。No
PolicyPriorityint内容转发优先级，范围[1,9999]，数字越大优先级越高。默认内容转发规则下为0。No
VServerIdstring所属VServerIdNo
TotalCountint默认内容转发类型下返回当前rs总数No
BackendSetarray[PolicyBackendSet]内容转发下rs的详细信息，参考PolicyBackendSetNo

BindSecurityPolicy

字段名类型描述信息必填
SecurityPolicyIdstring安全策略组IDNo
SecurityPolicyNamestring安全策略组名称No
TLSVersionstringTLS最低版本No
SSLCiphersarray[string]加密套件No
SecurityPolicyTypeint安全策略类型 0：预定义 1：自定义No

PolicyBackendSet

字段名类型描述信息必填
BackendIdstring所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关No
ResourceTypestring所添加的后端资源的类型，枚举值：UHost -> 云主机；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器；UHybrid->混合云主机；CUBE->Cube；UNI -> 虚拟网卡No
ResourceNamestring后端资源的实例名称No
SubResourceIdstring如果资源绑定了弹性网卡，则展示弹性网卡的资源IDNo
SubResourceNamestring如果资源绑定了弹性网卡，则展示弹性网卡的资源名称No
SubResourceTypestring”UNI”或者为空No
ObjectIdstring后端资源的对象IDNo
Portint所添加的后端资源服务端口No
PrivateIPstring后端资源的内网IPNo

SSLBindedTargetSet

字段名类型描述信息必填
VServerIdstringSSL证书绑定到的VServer的资源IDNo
VServerNamestring对应的VServer的名字No
ULBIdstringVServer 所属的ULB实例的资源IDNo
ULBNamestringULB实例的名称No

示例

请求示例

https://api.an-link.com/?Action=DescribeVServer
&Region=KYqxsypJ
&ProjectId=GsYJSKSC
&ULBId=gWhpMvaT
&VServerId=KyxsohIo
&Limit=2
&Offset=6

响应示例

{
  "Action": "DescribeVServerResponse",
  "DataSet": [
    {
      "BackendSet": [
        {
          "BackendId": "backend-XXX",
          "Enabled": 1,
          "Port": 80,
          "PrivateIP": "10.25.XX.17",
          "ResourceId": "uhost-XXXX",
          "ResourceName": "test",
          "ResourceType": "UHost",
          "Status": 0,
          "SubnetId": "subnet-XXXXX"
        }
      ],
      "ClientTimeout": 60,
      "CreateTime": 1529909432,
      "Domain": "",
      "EnableCompression": 1,
      "EnableHTTP2": 1,
      "ForwardPort": 4,
      "FrontendPort": 80,
      "ListenType": "RequestProxy",
      "Method": "Roundrobin",
      "MetricIdSet": [
        {
          "MetricId": "69538bf3-00bc-4385-85cc-XXXX",
          "Type": "OuterMode"
        }
      ],
      "MonitorType": "Port",
      "Path": "",
      "PersistenceInfo": "",
      "PersistenceType": "None",
      "PolicySet": [
        {
          "BackendSet": [
            {
              "BackendId": "backend-XXXXX",
              "ObjectId": "b47f082b-684f-4d5c-8dc4-XXXX",
              "Port": 80,
              "PrivateIP": "10.25.XX.17",
              "ResourceName": "test"
            }
          ],
          "Match": "",
          "PolicyId": "",
          "PolicyPriority": 0,
          "PolicyType": "Default",
          "TotalCount": 1,
          "Type": "",
          "VServerId": "vserver-XXXXX"
        }
      ],
      "Protocol": "HTTP",
      "SSLSet": [],
      "SecurityPolicy": {},
      "Status": 0,
      "ULBId": "ulb-XXX",
      "VServerId": "vserver-XXX",
      "VServerName": "VServer"
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}
获取传统型负载均衡信息 - DescribeULBSimple获取SSL证书信息 - DescribeSSL