ListInstance - 查询实例列表

查询实例列表。

调试

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

授权信息

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

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

请求参数

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

代播实例的 ID。

ddos_diversion_public_cn-xxxxxxxxxxxxx
Namestring

实例名称。

测试实例。
Statusstring

实例状态。取值:

  • normal:表示正常运行的实例。
  • expired:表示过期的实例。
  • deleting:表示处于删除中的实例。
  • stopped:表示停止的实例。
normal
Pagelong

页码。 默认值:1。

1
Numlong

数量。默认值:100。

100

返回参数

名称类型描述示例值
object
Codelong

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。
200
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95
Messagestring

返回信息。

successful
Dataobject

返回结果。

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "RequestId": "B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95",
  "Message": "successful",
  "Data": {
    "Total": 0,
    "Page": 0,
    "Num": 0,
    "Instances": [
      {
        "UserId": "",
        "SaleId": "",
        "InstanceId": "",
        "Name": "",
        "Status": "",
        "Comment": "",
        "Message": "",
        "Spec": {
          "IdcNumbers": "",
          "NormalBandwidth": "",
          "IpSubnetNums": "",
          "Coverage": "",
          "Edition": "",
          "MitigationCapacity": "",
          "MitigationNums": "",
          "DiversionType": "",
          "MitigationAnalysis": "",
          "MitigationAnalysisCapacity": "",
          "InitialInstallation": "",
          "InitialQty": ""
        },
        "GmtExpire": "",
        "GmtCreate": "",
        "GmtModify": ""
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400AuthenticationFailedUser authentication failed.用户认证失败。
400AutoScheduleRuleExistThe auto schedule rule already exists.调度规则已存在。
400AutoScheduleRuleNotExistThe auto schedule rule dose not exist.调度规则不存在。
400BlackHoleConfigurationErrorA black hole configuration error occurred.黑洞配置错误。
400CleanConfigurationErrorA clean configuration error occurred.清洗配置错误。
400CoveredNetThe CIDR block is overwritten.网段被其他网段覆盖。
400DatabaseErrorA database error.数据库错误。
400DeclaredNetThe CIDR block has been advertised.网段处于宣告状态。
400DefenseConfigurationErrorA defense configuration error occurred.防护配置错误。
400ForwardConfigurationNotExistThe CIDR block forwarding configuration is not found.网段转发配置不存在。
400ForwardNotExistThe CIDR block zone forwarding configuration is not found.网段可用区转发配置不存在。
400ForwardRuleNotExistThe CIDR block forwarding rule is not found.网段转发规则不存在。
400HttpFailedHTTP request failed.HTTP 请求失败。
400IDNSubnetsCountLimitThe maximum number of IDCs of the instance is exceeded.实例的IDC数量达到上限
400InstanceExistThe instance already exists.实例已经存在。
400InstanceNetConfigurationExistThe instance CIDR block configuration already exists.实例网段配置已存在。
400InstanceNotExistThe instance is not found.实例不存在。
400InstanceUpstreamLimitThe maximum number of reinjection configurations for the instance is exceeded.实例的回注配置数量受限。
400InternalErrorAn internal error occurred.内部错误。
400InvalidNetInvalid CIDR block.网段不合法。
400InvalidParamInvalid parameter value.参数非法。
400IPSubnetsCountLimitThe maximum number of CIDR blocks of the instance is exceeded.实例的网段数量达到上限。
400NetCannotExtendThe CIDR block cannot be extended.网段不能被扩容。
400NetConfigurationExistThe CIDR block configuration already exists.网段配置已存在。
400NetConfigurationNotExistThe CIDR block configuration is not found.网段配置不存在。
400NetForwardDeleteThe CIDR block forwarding is being deleted.网段转发删除中。
400NetMaskOutOfRangeThe subnet mask of the CIDR block is invalid.网段掩码超出范围。
400NetNeedExtendThe CIDR block needs to be extended.网段需要扩容。
400NetStatusNotReadyThe CIDR block reinjection configuration has not been completed.网段回注配置未完成
400NetworkDeclearedFailedFailed to advertise the CIDR block.网段宣告失败。
400NetWorkNotExistThe CIDR block is not found.网段不存在。
400NetworkUndeclearedFailedFailed to cancel the advertisement of the CIDR block.网段解除宣告失败。
400ParameterNotEnoughRequired parameters are not specified.必填参数缺失。
400ParameterOutOfRangeInvalid parameter value.参数超出指定取值范围
400RegionNotExistThe region does not exist.可用区不存在。
400RequestMethodErrorAn incorrect request method.请求方式错误。
400SubnetCountLimitThe maximum number of subnets is exceeded.子网数量达到上限。
400UnKnownErrorAn unknown error occurred.未知错误。
400UpsteamNotCompleteThe reinjection configuration has not been completed.网段回注配置未完成。
400UpstreamConfigurationNotExistThe reinjection configuration is not found.回注配置不存在。
400JsonDecodeErrorJSON string decoding failed.JSON字符串转JSON对象失败。

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

变更历史

变更时间变更内容概要操作
2024-04-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-12-11OpenAPI 错误码发生变更查看变更详情