DescribeGtmInstanceStatus - 获取GTM实例状态(旧版)

获取实例的当前状态。

调试

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

授权信息

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

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

请求参数

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

语言。

en
InstanceIdstring

实例 ID。

gtm-cn-wwo3a3hbz**

返回参数

名称类型描述示例值
object
Statusstring

实例状态:

  • ALLOW:允许操作
  • DENY:不允许操作
ALLOW
StrategyNotAvailableNuminteger

当前生效地址池不可用的访问策略个数。

10
RequestIdstring

唯一请求识别码。

389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA
SwitchToFailoverStrategyNuminteger

切换到备用地址池的访问策略个数。

10
StatusReasonstring

实例状态原因列表

  • INSTANCE_OPERATE_BLACK_LIST:黑名单
  • BETA_INSTANCE:公测期实例
["BETA_INSTANCE"]
AddrNotAvailableNuminteger

故障地址个数。

10
AddrPoolNotAvailableNuminteger

不可用地址池个数。

10

示例

正常返回示例

JSON格式

{
  "Status": "ALLOW",
  "StrategyNotAvailableNum": 10,
  "RequestId": "389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA",
  "SwitchToFailoverStrategyNum": 10,
  "StatusReason": "[\"BETA_INSTANCE\"]",
  "AddrNotAvailableNum": 10,
  "AddrPoolNotAvailableNum": 10
}

错误码

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