功能介绍

获取租户创建的所有的智能购买组。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{domain_id}/auto-launch-groups

参数说明请参见表1。

表1 路径参数

参数	是否必选	描述
domain_id	是	租户域ID。

表2 查询参数

参数	是否必选	参数类型	描述
limit	否	Integer	查询返回智能购买组的数量限制。 取值范围：1-1000
marker	否	String	取值为上一页数据的最后一条记录的唯一标识。
name	否	String	智能购买组名称。
valid_since	否	String	请求开始时间，按照时间范围过滤。 按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。
valid_until	否	String	请求结束时间，按照时间范围过滤。 按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。

请求消息

无

响应消息

响应参数如表3所示。

表3 响应参数

参数	参数类型	描述
auto_launch_groups	Array of objects	智能购买组列表，详情请参见表4。
page_info	Object	页标记。

表4 auto_launch_groups参数信息

参数	参数类型	描述
id	String	智能购买组ID。
name	String	智能购买组名称。
type	String	请求类型。
status	String	智能购买组的运行状态。 SUBMITTED：已提交 ACTIVE：运行中 DELETING：删除中 DELETED：已删除
task_state	String	智能购买组的任务状态。 HANDLING：购买中 FULFILLED：智能购买组已满配 ERROR：智能购买组异常
valid_since	String	开始时间。
valid_until	String	结束时间。

表5 page_info参数信息

参数	参数类型	描述
next_marker	String	返回下一页查询地址。

请求示例

查询智能购买组列表。

GET https://{endpoint}/v2/{domain_id}/auto-launch-groups?limit=1

响应示例

{
    "auto_launch_groups": [
        {
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
            "name": "autoLaunchGroup1",
            "type": "maintain",
            "status": "ACTIVE",
            "task_state": "FULFILLED",
            "valid_since": "2022-11-04T15:58:13Z",
            "valid_until": "2022-11-06T15:58:13Z"
        }
    ],
    "page_info": {
        "next_marker": "616fb98f-46ca-475e-917e-2563e5a8cd19"
    }
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 智能购买组管理

内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家