全部产品
Search

搜索本产品

    云备份：DescribeClients - 查询客户端信息

    文档中心

    云备份：DescribeClients - 查询客户端信息

    更新时间：Dec 26, 2024

    获取一个或多个符合条件的备份客户端。

    接口说明

    该接口目前仅适用于 SAP HANA 备份，其他数据源的备份客户端请调用 DescribeBackupClients 接口。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    hbr:DescribeClientsget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    VaultIdstring是

    备份仓库 ID。

    		v-0001vk0z******xdyr
    ClientIdstring否

    备份客户端 ID。

    		c-000ed600******6b0
    PageNumberinteger否

    分页页码，从 1 开始，默认值为 1。

    		1
    PageSizeinteger否

    分页大小，最小值为 1，最大值为 99，默认值为 10。

    		10
    ClientTypestring是

    备份客户端类型。取值为ECS_AGENT，表示 SAP HANA 备份客户端。

    		ECS_AGENT
    SourceTypestring否

    数据源类型，取值为 HANA，表示 SAP HANA 备份。

    		HANA
    ClusterIdstring否

    SAP HANA 实例 ID。

    		cl-0005ni1******2l87
    ResourceGroupIdstring否

    资源组 ID。

    		rg-acfmw6bxl7o5qyq

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		17189276-465D-5EF3-8FFD-0FF51B5A41A0
    Successboolean

    请求是否成功。

    • true：成功
    • false：失败
    		true
    Codestring

    返回码，200 表示成功。

    		200
    Messagestring

    返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。

    		successful
    PageNumberinteger

    分页页码，从 1 开始，默认值为 1。

    		1
    PageSizeinteger

    分页大小，最小值为 1，最大值为 99，默认值为 10。

    		10
    TotalCountinteger

    总记录数。

    		12
    Clientsarray<object>

    备份客户端列表。

    Clientobject

    客户端信息。

    Statusstring

    备份客户端状态。取值包括：

    • REGISTERED：注册成功
    • ACTIVATED：激活成功
    • DEACTIVATED：激活失效
    • INSTALLING：安装中
    • INSTALL_FAILED：安装失败
    • NOT_INSTALLED：未安装
    • UPGRADING：升级中
    • UPGRADE_FAILED：升级失败
    • UNINSTALLING：卸载客户端中
    • UNINSTALL_FAILED：卸载客户端失败
    • STOPPED：客户端服务已停止
    • UNKNOWN：客户端失联
    		ACTIVATED
    VaultIdstring

    备份仓库 ID。

    		v-00029mx6o******n85lg
    UseHttpsboolean

    是否使用 HTTPS 传输数据。

    • true 表示使用 HTTPS 传输。
    • false 表示使用 HTTP 传输。
    		false
    NetworkTypestring

    网络类型，返回值包括：

    • CLASSIC：经典网络。
    • VPC：专有网络。
    		VPC
    ClientNamestring

    客户端名称。

    		client-20211224-101226
    ClientIdstring

    备份客户端 ID。

    		c-00062uu******2fgj
    AlertSettingstring

    告警设置。取值为 INHERITED，表示使用与备份库一致的报警方式。

    		INHERITED
    InstanceNamestring

    ECS 实例名称。

    		swh-hbr
    MaxVersionstring

    客户端最大版本号。

    		1.11.23
    CreatedTimelong

    客户端创建时间。

    		1554347313
    StatusMessagestring

    状态信息。

    		HANA_NOT_SUPPORT
    ClientTypestring

    备份客户端类型。取值为ECS_AGENT，表示 SAP HANA 备份客户端。

    		ECS_AGENT
    InstanceIdstring

    实例 ID。

    		i-wz9b6wya******n8yo
    UpdatedTimelong

    备份客户端更新时间。UNIX 时间，单位为秒。

    		1554347313
    ClientVersionstring

    备份客户端版本号。

    		1.11.16
    ClusterIdstring

    SAP HANA 实例 ID。

    		cl-0008c48frr******ncpk

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "17189276-465D-5EF3-8FFD-0FF51B5A41A0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 12,
  "Clients": {
    "Client": [
      {
        "Status": "ACTIVATED",
        "VaultId": "v-00029mx6o******n85lg",
        "UseHttps": false,
        "NetworkType": "VPC",
        "ClientName": "client-20211224-101226",
        "ClientId": "c-00062uu******2fgj",
        "AlertSetting": "INHERITED",
        "InstanceName": "swh-hbr",
        "MaxVersion": "1.11.23",
        "CreatedTime": 1554347313,
        "StatusMessage": "HANA_NOT_SUPPORT",
        "ClientType": "ECS_AGENT",
        "InstanceId": "i-wz9b6wya******n8yo",
        "UpdatedTime": 1554347313,
        "ClientVersion": "1.11.16",
        "ClusterId": "cl-0008c48frr******ncpk"
      }
    ]
  }
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史