ListReleaseRecords--函数服务-火山引擎

文档中心

立即注册

导航

ListReleaseRecords

最近更新时间：2024.08.08 10:29:16首次发布时间：2024.08.08 10:29:16

查询函数发布记录。

请求说明

请求方式：POST
请求地址：http://open.volcengineapi.com/?Action=ListReleaseRecords&Version=2024-06-06 HTTP/1.1

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListReleaseRecords	接口名称。当前 API 的名称为 `ListReleaseRecords`。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 `2024-06-06`。
FunctionId	String	是	nuvpugx5	函数 ID。
PageNumber	Integer	否	1	分页参数，当前页码，默认为 1。
PageSize	Integer	否	10	分页参数，每页大小，默认为 10。
Filters	Array of Filter	否	[{"Name": "Id", "Value": ["7d2q3fz76tryveeu"]}]	查询过滤条件。
OrderBy	Object of OrderBy	否	{"Key":"CreationTime", "Ascend":false}	查询排序参数。

Filter

参数	类型	是否必选	示例值	描述
Name	String	否	Id	过滤键枚举： Id（发布记录 ID） Status（发布状态） SourceRevisionNumber（历史版本号） TargetRevisionNumber（目标版本号）说明过滤值不支持模糊查询。
Values	Array of String	否	["7d2q3fz76tryveeu"]	查询的筛选值，是一个数组。

参数

类型

是否必选

示例值

描述

Name

String

否

过滤键枚举：

Id（发布记录 ID）
Status（发布状态）
SourceRevisionNumber（历史版本号）
TargetRevisionNumber（目标版本号）

说明

过滤值不支持模糊查询。

Values

Array of String

否

["7d2q3fz76tryveeu"]

查询的筛选值，是一个数组。

OrderBy

参数	类型	是否必选	示例值	描述
Key	String	是	CreateTime	用于排序的键名： CreateTime：创建时间 FinishTime：完成时间
Ascend	Boolean	否	true	排序结果是否按升序排序。 true：升序 false（默认）：降序

参数

类型

是否必选

示例值

描述

Key

String

是

CreateTime

用于排序的键名：

CreateTime：创建时间
FinishTime：完成时间

Ascend

Boolean

否

true

排序结果是否按升序排序。

true：升序
false（默认）：降序

请求示例

POST http://open.volcengineapi.com/?Action=ListReleaseRecords&Version=2024-06-06 HTTP/1.1
Content-Type: application/json
{
    "FunctionId": "nuvpugx5",
    "PageNumber": 1,
    "PageSize": 10,
    "Filters": [
        {
            "Name": "Id",
            "Value": [
                "7d2q3fz76tryveeu"
            ]
        }
    ],
    "OrderBy": {
        "Key": "CreationTime",
        "Ascend": false
    }
}

返回参数

参数	类型	示例值	描述
Items	Array of ReleaseRecord		函数的发布记录列表。
Total	Integer	1	返回列表数据的总量。

ReleaseRecord

参数	类型	示例值	描述
Id	String	cytso41iugitj01x	发布记录 ID，即 Release Record ID。
Status	String	finished	发布状态： rolling：发布中 finished：已完成 rollbacking：回滚中 rollbacked：已回滚 failed：已失败
FinishTime	String	2024-06-14 15:31:07.143863491 +0800 CST m=+88714.902440914	完成时间。
FunctionId	String	nuvpugx5	函数 ID。
Description	String	Support xxx feature	发布信息描述。
CreationTime	String	2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864	创建时间。
LastUpdateTime	String	2024-06-14 15:31:07.143863491 +0800 CST m=+88714.902440914	更新时间。
SourceRevisionNumber	Integer	9	发布的历史版本号。
TargetRevisionNumber	Integer	10	发布的目标版本号。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListReleaseRecords",
        "Version": "2024-06-06",
        "Service": "vefaas",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "cytso41iugitj01x",
                "Status": "finished",
                "FinishTime": "2024-06-14 15:31:07.143863491 +0800 CST m=+88714.902440914",
                "FunctionId": "nuvpugx5",
                "Description": "Support xxx feature",
                "CreationTime": "2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864",
                "LastUpdateTime": "2024-06-14 15:31:07.143863491 +0800 CST m=+88714.902440914",
                "SourceRevisionNumber": 9,
                "TargetRevisionNumber": 10
            }
        ],
        "Total": 1
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。