调用DescribeOnDemandInstanceStatus查询代播实例的详细状态信息

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-antiddosbag:DescribeOnDemandInstanceStatus

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	代播实例的地域 ID。说明您可以调用 DescribeRegions 查询 DDoS 原生防护支持的所有地域信息。	cn-zhangjiakou
InstanceIdList	array	是	要查询的代播实例的 ID 列表。说明您可以调用 ListInstance 查询所有代播实例的 ID。	ddosbgp-cn-z2q1qzxb****
	string	否	实例的 ID。	ddosbgp-cn-z2q1qzxb****

调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用 API 的请求格式，请参见本文示例中的请求示例。

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	CC49FF51-612F-429B-AB1E-374B3F115396
Instances	array	代播实例的详细信息。
	object
UserId	string	阿里云账号 ID。	171986973287****
Mode	string	代播防护的启动模式。取值： manual：表示手动启动。 netflow-auto：表示通过 NetFlow 网络流量监测自动启动。	netflow-auto
InstanceId	string	代播实例的 ID。说明该参数仅在返回多个代播实例时才会返回。目前仅返回一个代播实例，该参数不会返回。	ddosbgp-cn-z2q1qzxb****
Declared	string	海外 IDC 的路由宣告状态信息。以 JSON 数组格式转化成字符串表示，JSON 数组中的每个结构体包含以下参数： region：String 类型 \| 海外 IDC 代码。关于 IDC 代码对应的地域信息，请参见该表格下方的海外 IDC 代码说明。 declared：String 类型 \| 该 IDC 是否宣告路由，取值：0（表示未宣告） \| 1（表示宣告）。	[{\"region\":\"oe24\",\"declared\":0},{\"region\":\"oe26\",\"declared\":0},{\"region\":\"oe28\",\"declared\":0},{\"region\":\"oi39\",\"declared\":0},{\"region\":\"us50\",\"declared\":0},{\"region\":\"jp141\",\"declared\":0}]
RegistedAs	string	自治系统 AS（Autonomous System）号码。目前取值固定为 0，表示暂未启用。	0
Net	string	代播网段。	47.*.*.0/24
Desc	string	代播实例的描述。说明该参数仅在返回多个代播实例时才会返回。目前仅返回一个代播实例，该参数不会返回。	test

海外 IDC 代码

下表描述了不同海外地域部署的代播防护 IDC 的代码。

地域	IDC 代码
美国（硅谷）	oe24、oe25、oc27、ot7
美国（弗吉尼亚）	us44-a、us44-b、us68、us50、us51
中国（香港）	meg、oe26、hk45、hk71
新加坡	oe28、og37、os30、sg94、sg52、sg113
德国（法兰克福）	de46、de81、oe38、oi39
俄罗斯（莫斯科）	ol31、ru85、ru66
英国（伦敦）	gb82、gb83、gb33、gb124
日本（东京）	jp59、jp42、jp43、jp138、jp141
马来西亚（吉隆坡）	my86、my87、my88、my115
印度尼西亚（雅加达）	id56、id55、id35、id90

示例

正常返回示例

JSON格式

{
  "RequestId": "CC49FF51-612F-429B-AB1E-374B3F115396",
  "Instances": [
    {
      "UserId": "171986973287****",
      "Mode": "netflow-auto",
      "InstanceId": "ddosbgp-cn-z2q1qzxb****",
      "Declared": "[{\\\"region\\\":\\\"oe24\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"oe26\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"oe28\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"oi39\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"us50\\\",\\\"declared\\\":0},{\\\"region\\\":\\\"jp141\\\",\\\"declared\\\":0}]",
      "RegistedAs": "0",
      "Net": "47.***.***.0/24",
      "Desc": "test"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。