describeAgs

描述

使用过滤条件查询一个或多个高可用组。

接口说明

使用过滤条件查询一个或多个高可用组。

请求方式

GET

请求地址

https://ag.jdcloud-api.com/v1/regions/{regionId}/availabilityGroups

名称	类型	是否必需	示例值	描述
regionId	String	是	cn-north-1	地域ID。可参考地域及可用区。

请求参数

名称	类型	是否必需	默认值	描述
pageNumber	Integer	否	1	页码，默认值为1。
pageSize	Integer	否	20	分页大小，默认为20，取值范围：[10-100]。
filters	Filter[]	否	-	agName：ag名字，支持模糊匹配； agId：agID，精确匹配； instanceTemplateId：实例模板ID，精确匹配； vpcId：vpcID，精确匹配； placementType：放置策略;； agType - ag类型，精确匹配，可选值：vm,kvm,docker,nativecontainer,pod configurationType - 配置类型，精确匹配。

Filter

名称	类型	是否必需	默认值	描述
name	String	是	agName	过滤条件的名称
operator	String	否	eq	过滤条件的操作符，默认eq
values	String[]	是	ag-fljk****tt	过滤条件的值

返回参数

名称	类型	示例值	描述
result	Result	-	请求结果。
requestId	String	c2hmmaan8w06w19qcdfuic4w03****2d	请求ID。

Result

名称	类型	示例值	描述
ags	AvailabilityGroup[]	-	高可用组。
totalCount	Integer	5	查询到的高可用组数。

AvailiabilityGroup

名称	类型	示例值	描述
id	String	ag-fljk****tt	高可用组ID。
name	String	ag-demo	高可用组名称。
description	String	关于高可用组的描述	描述。
instanceTemplateId	String	it-7vsi****xm	实例模板的ID。
azs	String[]	cn-north-1c	可用区域列表。
vpcId	String	vpc-dqf5****hj	可用区域。
agType	String	vm	高可用组资源类型。
createTime	String	2023-05-10 10:10:00	创建时间。
count	Number	20	高可用组中实例的数量。
autoScaling	Boolean	true	是否开启自动伸缩。
configurationType	String	strict	高可用组配置类型。
placementType	String	fd	高可用组放置类型。 可能值： fd 故障
instancesQuotas	InstancesQuota[]	-	高可用组中实例数量的限制。
instances	InstanceSpec[]	-	高可用组中各个示例规格
autoscalingSpec	AutoscalingSpec	-	高可用组中弹性伸缩规格

InstancesQuota

名称	类型	示例值	描述
az	String	prod_bj02	az。
limit	Integer	10	配额上限。
used	Integer	6	已用配额。

InstanceSpec

名称	类型	示例值	描述
instanceId	String		主机ID
instanceName	String		实例名称
status	String		主机状态
agStatus	String		打开伸缩功能后，主机在伸缩组中状态
isManaged	Boolean		打开伸缩功能后，主机是否托管给伸缩组
az	String		可用区
networkInterfaceSpec	NetworkInterfaceSpec	-	实例网络规格
charge	Charge	-	实例计费模式

AutoscalingSpec

名称	类型	示例值	描述
minSize	Integer	2	伸缩组最小实例数，取值范围：[0-300]。若高可用组分散策略为host或switch，则组内最小实例数不能大于组quota限制
maxSize	Integer	10	伸缩组最大实例数，取值范围：[0-300]。若高可用组分散策略为host或switch，则组内最大实例数不能大于组quota限制
desiredCapacity	Integer	6	伸缩组期望实例数，取值范围为：[最小实例数，最大实例数]
healthCheck	Boolean	true	伸缩组内实例是否需要健康检查，默认值：true
coolDownSeconds	Integer	300	冷却时间，默认值为300（单位：秒）,范围为[0-86400]
scalingPolicy	String	Balance	默认值：Balance，均衡分布，当前仅支持这个值
removalPolicy	String	OldestResource	实例移出策略，可选值： OldestResource：最早创建实例，默认值； NewestResource：最新创建实例

NetworkInterfaceSpec

名称	类型	示例值	描述
privateIpAddress	String	10.0.0.1	私有IP的IPV4地址
elasticIpAddress	String	1.2.3.4	弹性IP实例地址

Charge

名称	类型	示例值	描述
chargeMode	String		支付模式，可选值： prepaid_by_duration：预付费，默认值； postpaid_by_usage：按用量后付费； postpaid_by_duration：按配置后付费； postpaid_by_spot：抢占式实例后付费
chargeStatus	String		费用支付状态，可选值： normal：正常； overdue：已到期； arrear：欠费
chargeStartTime	String		计费开始时间，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ
chargeExpiredTime	String		过期时间，预付费资源的到期时间，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ，后付费资源此字段内容为空
chargeRetireTime	String		预期释放时间，资源的预期释放时间，预付费/后付费资源均有此值，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ

返回码

HTTP状态码	错误码	描述	错误解析
200		OK
400	INVALID_ARGUMENT	Invalid parameter	无效参数。
401	FAILED_PRECONDITION	Authentication failed	权限校验失败。
404	NOT_FOUND	Not found	资源不存在。
500	INTERNAL	Internal server error	系统内部错误，请稍后重试。如果多次尝试失败，请提交工单。
503	UNKNOWN	Service unavailable	服务暂时不可用，请稍后重试。如果多次尝试失败，请提交工单。