DescribeSummary - 查询概览信息

查询概览信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object
RequestIdstring

请求 id。

DE78056B-E82A-52FD-BF5E-F737D8B63845
Successboolean

是否成功。

True
ServerCountlong

受保护服务器总数量

2
TotalSizelong

站点对总数量

10
Codestring

状态码

200
Messagestring

返回信息。

successful
DbServerCountlong
-
SiteCountlong

站点数量

4
ReplicationDetailsobject

复制状态统计信息

WarningServersarray<object>

处于警告状态的受保护服务器信息

warningServerobject

处于警告状态的受保护服务器信息

ServerIdstring

受保护服务器 ID

sr-000fzufp79icz33l4pak
InstanceIdstring

受保护服务器实例 ID

i-bp1a4374akk4527gbt9x
SitePairIdstring

受保护服务器站点对 ID

s-000bzkmmlwh5riquud19
Rpolong

RPO

30
Statusstring

状态

replicating
ConnectionStatusstring

连接状态

connected
CriticalServersarray<object>

处于危险状态的受保护服务器信息

criticalServerobject

处于危险状态的受保护服务器信息

ServerIdstring

受保护服务器 ID

sr-0005qxusucb0fqqdf4ba
InstanceIdstring

受保护服务器实例 ID

i-bp1a4374akk4527gbt9x
SitePairIdstring

受保护服务器站点对 ID

s-0005qxusucbii3ba2uve
Rpolong

RPO

30
Statusstring

状态

replicating
ConnectionStatusstring

连接状态

connected
NotApplicableServersarray<object>

处于非复制状态的受保护服务器信息

notApplicableServerobject

处于未复制状态的受保护服务器信息

ServerIdstring

受保护服务器 ID

sr-000iji78mxxc93yldd2e
InstanceIdstring

受保护服务器实例 ID

i-bp1a4374akk4527gbt9x
SitePairIdstring

受保护服务器站点对 ID

s-000bzkmmlwh5riquud19
Rpolong

RPO

40
Statusstring

状态

replicating
ConnectionStatusstring

连接状态

connected

示例

正常返回示例

JSON格式

{
  "RequestId": "DE78056B-E82A-52FD-BF5E-F737D8B63845",
  "Success": true,
  "ServerCount": 2,
  "TotalSize": 10,
  "Code": "200",
  "Message": "successful",
  "DbServerCount": 0,
  "SiteCount": 4,
  "ReplicationDetails": {
    "WarningServers": {
      "warningServer": [
        {
          "ServerId": "sr-000fzufp79icz33l4pak",
          "InstanceId": "i-bp1a4374akk4527gbt9x",
          "SitePairId": "s-000bzkmmlwh5riquud19",
          "Rpo": 30,
          "Status": "replicating",
          "ConnectionStatus": "connected"
        }
      ]
    },
    "CriticalServers": {
      "criticalServer": [
        {
          "ServerId": "sr-0005qxusucb0fqqdf4ba",
          "InstanceId": "i-bp1a4374akk4527gbt9x",
          "SitePairId": "s-0005qxusucbii3ba2uve",
          "Rpo": 30,
          "Status": "replicating",
          "ConnectionStatus": "connected"
        }
      ]
    },
    "NotApplicableServers": {
      "notApplicableServer": [
        {
          "ServerId": "sr-000iji78mxxc93yldd2e",
          "InstanceId": "i-bp1a4374akk4527gbt9x",
          "SitePairId": "s-000bzkmmlwh5riquud19",
          "Rpo": 40,
          "Status": "replicating",
          "ConnectionStatus": "connected"
        }
      ]
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-16OpenAPI 返回结构发生变更查看变更详情