全部产品
Search
文档中心

DDoS 防护:DescribeInstanceStatus - 查询指定的DDoS高防实例的状态

更新时间:Mar 03, 2024

查询指定的DDoS高防实例的状态。

调试

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

授权信息

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

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

请求参数

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

要查询的 DDoS 高防实例的 ID。

说明 您可以调用 DescribeInstanceIds 查询所有 DDoS 高防(中国内地)或 DDoS 高防(非中国内地)实例的 ID。
ddoscoo-cn-6ja1y6p5****
ProductTypeinteger

要查询的 DDoS 高防实例的类型。取值:

  • 1:表示 DDoS 高防(中国内地)实例。
  • 2:表示 DDoS 高防(非中国内地)实例。
1

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

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

返回参数

名称类型描述示例值
object
InstanceStatusinteger

DDoS 高防实例的状态。取值:

  • 1:表示正常。
  • 2:表示已过期。
  • 3:表示存在欠费。
  • 4:表示已释放。
1
RequestIdstring

本次请求的 ID。

112777CC-2AD6-46FC-A263-00B931406FCD
InstanceIdstring

DDoS 高防实例的 ID。

ddoscoo-cn-6ja1y6p5****

示例

正常返回示例

JSON格式

{
  "InstanceStatus": 1,
  "RequestId": "112777CC-2AD6-46FC-A263-00B931406FCD",
  "InstanceId": "ddoscoo-cn-6ja1y6p5****"
}

错误码

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