ListInstance - 查询实例列表_DDoS防护(Anti-DDoS)-阿里云帮助中心

查询实例列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ddosdiversion:ListInstance

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SaleId	string	否	代播实例的 ID。	ddos_diversion_public_cn-xxxxxxxxxxxxx
Name	string	否	实例名称。	测试实例。
Status	string	否	实例状态。取值： normal：表示正常运行的实例。 expired：表示过期的实例。 deleting：表示处于删除中的实例。 stopped：表示停止的实例。	normal
Page	integer	否	页码。默认值：1。	1
Num	integer	否	数量。默认值：100。	100

返回参数

名称	类型	描述	示例值
	object
Code	integer	接口返回码： 200：表示成功。其它：表示错误码。	200
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95
Message	string	返回信息。	successful
Data	object	返回结果。
Total	integer	返回数据的总条数。	10
Page	integer	页码。	1
Num	integer	数量。	100
Instances	array	代播实例详情数组。
	object
UserId	string	用户 ID。	177xxxxxxxxxxxxx
SaleId	string	代播实例的 ID。	ddos_diversion_public_cn-xxxxxxxxxxxxx
InstanceId	string	实例 ID。	ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx
Name	string	实例名称。	测试实例。
Status	string	实例状态。取值： normal：表示正常运行的实例。 expired：表示过期的实例。 deleting：表示处于删除中的实例。 stopped：表示停止的实例。	normal
Comment	string	备注。	测试实例。
Message	string	实例配置信息。	successful
Spec	object	规格信息。
IdcNumbers	string	Idc 数量。取值范围：1-10。	1
NormalBandwidth	string	干净带宽。单位：Mbps。	100
IpSubnetNums	string	网段（C 段）数量。取值范围：1-10000。	1
Coverage	string	资产区域。	international_and_hmt
Edition	string	防护套餐。	enterprise
MitigationCapacity	string	最大防护能力。	unlimited
MitigationNums	string	防护次数。	unlimited
DiversionType	string	代播模式。取值： on-demand； always-on。	on-demand
MitigationAnalysis	string	防护日志。	off
MitigationAnalysisCapacity	string	防护日志容量。	3T
InitialInstallation	string	初装模式。	gre_tunnel_by_pccw
InitialQty	string	初装数量。	1
GmtExpire	string	到期时间。	2022-12-15 11:10:42
GmtCreate	string	购买时间。	2022-12-15 11:10:42
GmtModify	string	更新时间。	2022-12-15 11:10:42

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "RequestId": "B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95",
  "Message": "successful",
  "Data": {
    "Total": 10,
    "Page": 1,
    "Num": 100,
    "Instances": [
      {
        "UserId": "177xxxxxxxxxxxxx",
        "SaleId": "ddos_diversion_public_cn-xxxxxxxxxxxxx",
        "InstanceId": "ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx",
        "Name": "测试实例。",
        "Status": "normal",
        "Comment": "测试实例。",
        "Message": "successful",
        "Spec": {
          "IdcNumbers": "1",
          "NormalBandwidth": "100",
          "IpSubnetNums": "1",
          "Coverage": "international_and_hmt",
          "Edition": "enterprise",
          "MitigationCapacity": "unlimited",
          "MitigationNums": "unlimited",
          "DiversionType": "on-demand",
          "MitigationAnalysis": "off",
          "MitigationAnalysisCapacity": "3T",
          "InitialInstallation": "gre_tunnel_by_pccw",
          "InitialQty": "1"
        },
        "GmtExpire": "2022-12-15 11:10:42",
        "GmtCreate": "2022-12-15 11:10:42",
        "GmtModify": "2022-12-15 11:10:42"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	AuthenticationFailed	User authentication failed.	用户认证失败。
400	AutoScheduleRuleExist	The auto schedule rule already exists.	调度规则已存在。
400	AutoScheduleRuleNotExist	The auto schedule rule dose not exist.	调度规则不存在。
400	BlackHoleConfigurationError	A black hole configuration error occurred.	黑洞配置错误。
400	CleanConfigurationError	A clean configuration error occurred.	清洗配置错误。
400	CoveredNet	The CIDR block is overwritten.	网段被其他网段覆盖。
400	DatabaseError	A database error.	数据库错误。
400	DeclaredNet	The CIDR block has been advertised.	网段处于宣告状态。
400	DefenseConfigurationError	A defense configuration error occurred.	防护配置错误。
400	ForwardConfigurationNotExist	The CIDR block forwarding configuration is not found.	网段转发配置不存在。
400	ForwardNotExist	The CIDR block zone forwarding configuration is not found.	网段可用区转发配置不存在。
400	ForwardRuleNotExist	The CIDR block forwarding rule is not found.	网段转发规则不存在。
400	HttpFailed	HTTP request failed.	HTTP 请求失败。
400	IDNSubnetsCountLimit	The maximum number of IDCs of the instance is exceeded.	实例的IDC数量达到上限
400	InstanceExist	The instance already exists.	实例已经存在。
400	InstanceNetConfigurationExist	The instance CIDR block configuration already exists.	实例网段配置已存在。
400	InstanceNotExist	The instance is not found.	实例不存在。
400	InstanceUpstreamLimit	The maximum number of reinjection configurations for the instance is exceeded.	实例的回注配置数量受限。
400	InternalError	An internal error occurred.	内部错误。
400	InvalidNet	Invalid CIDR block.	网段不合法。
400	InvalidParam	Invalid parameter value.	参数非法。
400	IPSubnetsCountLimit	The maximum number of CIDR blocks of the instance is exceeded.	实例的网段数量达到上限。
400	NetCannotExtend	The CIDR block cannot be extended.	网段不能被扩容。
400	NetConfigurationExist	The CIDR block configuration already exists.	网段配置已存在。
400	NetConfigurationNotExist	The CIDR block configuration is not found.	网段配置不存在。
400	NetForwardDelete	The CIDR block forwarding is being deleted.	网段转发删除中。
400	NetMaskOutOfRange	The subnet mask of the CIDR block is invalid.	网段掩码超出范围。
400	NetNeedExtend	The CIDR block needs to be extended.	网段需要扩容。
400	NetStatusNotReady	The CIDR block reinjection configuration has not been completed.	网段回注配置未完成
400	NetworkDeclearedFailed	Failed to advertise the CIDR block.	网段宣告失败。
400	NetWorkNotExist	The CIDR block is not found.	网段不存在。
400	NetworkUndeclearedFailed	Failed to cancel the advertisement of the CIDR block.	网段解除宣告失败。
400	ParameterNotEnough	Required parameters are not specified.	必填参数缺失。
400	ParameterOutOfRange	Invalid parameter value.	参数超出指定取值范围
400	RegionNotExist	The region does not exist.	可用区不存在。
400	RequestMethodError	An incorrect request method.	请求方式错误。
400	SubnetCountLimit	The maximum number of subnets is exceeded.	子网数量达到上限。
400	UnKnownError	An unknown error occurred.	未知错误。
400	UpsteamNotComplete	The reinjection configuration has not been completed.	网段回注配置未完成。
400	UpstreamConfigurationNotExist	The reinjection configuration is not found.	回注配置不存在。
400	JsonDecodeError	JSON string decoding failed.	JSON字符串转JSON对象失败。

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

变更历史

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