文档

DescribeGtmAccessStrategy - 获取访问策略详细信息(旧版)

更新时间:

根据策略ID获取策略详细信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Langstring

语言。

en
StrategyIdstring

访问策略 ID。

hra0hs

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求识别码。

BA1608CA-834C-4E63-8682-8AF0B11ED72D
InstanceIdstring

关联的 GTM 实例 ID。

gtm-cn-wwo3a3hbz**
StrategyIdstring

策略 ID。

hra0hs
DefaultAddrPoolStatusstring

主地址池集合可用状态。其中:

  • AVAILABLE:可用
  • NOT_AVAILABLE:不可用
AVAILABLE
FailoverAddrPoolIdstring

备地址池集合 ID。 若未设置备地址池集合,传值 EMPTY

hra0i2
AccessStatusstring

访问状态。其中:

  • DEFAULT:访问主地址池集合,表示正常
  • FAILOVER:访问备地址池集合,表示异常
DEFAULT
DefaultAddrPoolMonitorStatusstring

主地址池集合健康检查状态。其中:

  • OPEN:开启
  • CLOSE:关闭
  • UNCONFIGURED:未配置
OPEN
DefaultAddrPoolNamestring

主地址池集合名称。

地址池1
DefultAddrPoolIdstring

备地址池集合 ID。

hra0i1
StrategyNamestring

访问策略名称。

全局
FailoverAddrPoolStatusstring

备地址池集合可用状态。其中:

  • AVAILABLE:可用
  • NOT_AVAILABLE:不可用
AVAILABLE
AccessModestring

地址池集合切换策略:

  • AUTO:自动切换
  • DEFAULT:主地址池集合
  • FAILOVER: 备地址池集合
AUTO
StrategyModestring

策略模式 SELF_DEFINED 自定义。

SELF_DEFINED
FailoverAddrPoolMonitorStatusstring

备地址池集合健康检查状态。其中:

  • OPEN:开启
  • CLOSE:关闭
  • UNCONFIGURED:未配置
OPEN
FailoverAddrPoolNamestring

备地址池集合名称。

地址池2
Linesarray<object>

解析请求来源列表。

object
GroupNamestring

解析请求来源分组名称。

Global
LineCodestring

解析请求来源编码。

default
LineNamestring

解析请求来源名称。

Global
GroupCodestring

解析请求来源分组编码。

DEFAULT

示例

正常返回示例

JSON格式

{
  "RequestId": "BA1608CA-834C-4E63-8682-8AF0B11ED72D",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "StrategyId": "hra0hs",
  "DefaultAddrPoolStatus": "AVAILABLE",
  "FailoverAddrPoolId": "hra0i2",
  "AccessStatus": "DEFAULT",
  "DefaultAddrPoolMonitorStatus": "OPEN",
  "DefaultAddrPoolName": "地址池1",
  "DefultAddrPoolId": "hra0i1",
  "StrategyName": "全局",
  "FailoverAddrPoolStatus": "AVAILABLE",
  "AccessMode": "AUTO",
  "StrategyMode": "SELF_DEFINED",
  "FailoverAddrPoolMonitorStatus": "OPEN",
  "FailoverAddrPoolName": "地址池2",
  "Lines": {
    "Line": [
      {
        "GroupName": "Global",
        "LineCode": "default",
        "LineName": "Global",
        "GroupCode": "DEFAULT"
      }
    ]
  }
}

错误码

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