ListCalendars - 获取日历列表

获取日历列表

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

集群 ID。

xxljob-b6ec1xxxx
CalendarNamestring

日历名称

workday
Yearinteger

年。

2024
FetchCalendarDetailboolean

是否拉取日历明细(默认:false)

  • false:不返回每月的详细天列表,只返回基础信息。
  • true:返回每月日历详细天列表。
false
MaxResultsinteger

本次读取的最大数据量,默认值为 10。

10
NextTokenstring

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕, 第一次查询不需要提供这个参数。

eCKqVlS5FKF5EWGGOo8EgQ==

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

3835AA29-2298-5434-BC53-9CC377CDFD2C
Codeinteger

响应码。

200
Messagestring

错误信息。

Parameter error: content is null.
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true
Dataobject
Recordsarray<object>

数据列表。

Recordobject

数据列表。

CalendarNamestring

日历名称

workday
Yearinteger

年。

2025
Monthsstring

每个月的日历,JSON 数组格式

[ {"month":1,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]}, {"month":2,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]}, {"month":3,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]}, {"month":4,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]}, {"month":5,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]}, {"month":6,"days":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]}, {"month":7,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]}, {"month":8,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]}, {"month":9,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]}, {"month":10,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]}, {"month":11,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]}, {"month":12,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]} ]
NextTokenstring

当符合查询条件的数据未读取完时,服务端会返回 nextToken,此时可以使用 nextToken 继续读取后面的数据。第一次查询不需要提供这个参数。

eCKqVlS5FKF5EWGGOo8EgQ==
Totallong

总条数。

10
MaxResultsinteger

本次读取的最大数据量,默认值为 10。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "3835AA29-2298-5434-BC53-9CC377CDFD2C",
  "Code": 200,
  "Message": "Parameter error: content is null.\n",
  "Success": true,
  "Data": {
    "Records": [
      {
        "CalendarName": "workday",
        "Year": 2025,
        "Months": [
          {
            "month": 1,
            "days": [
              1,
              2,
              3,
              6,
              7,
              8,
              9,
              10,
              13,
              14,
              15,
              16,
              17,
              20,
              21,
              22,
              23,
              24,
              27,
              28,
              29,
              30,
              31
            ]
          },
          {
            "month": 2,
            "days": [
              3,
              4,
              5,
              6,
              7,
              10,
              11,
              12,
              13,
              14,
              17,
              18,
              19,
              20,
              21,
              24,
              25,
              26,
              27,
              28
            ]
          },
          {
            "month": 3,
            "days": [
              3,
              4,
              5,
              6,
              7,
              10,
              11,
              12,
              13,
              14,
              17,
              18,
              19,
              20,
              21,
              24,
              25,
              26,
              27,
              28,
              31
            ]
          },
          {
            "month": 4,
            "days": [
              1,
              2,
              3,
              4,
              7,
              8,
              9,
              10,
              11,
              14,
              15,
              16,
              17,
              18,
              21,
              22,
              23,
              24,
              25,
              28,
              29,
              30
            ]
          },
          {
            "month": 5,
            "days": [
              1,
              2,
              5,
              6,
              7,
              8,
              9,
              12,
              13,
              14,
              15,
              16,
              19,
              20,
              21,
              22,
              23,
              26,
              27,
              28,
              29,
              30
            ]
          },
          {
            "month": 6,
            "days": [
              2,
              3,
              4,
              5,
              6,
              9,
              10,
              11,
              12,
              13,
              16,
              17,
              18,
              19,
              20,
              23,
              24,
              25,
              26,
              27,
              30
            ]
          },
          {
            "month": 7,
            "days": [
              1,
              2,
              3,
              4,
              7,
              8,
              9,
              10,
              11,
              14,
              15,
              16,
              17,
              18,
              21,
              22,
              23,
              24,
              25,
              28,
              29,
              30,
              31
            ]
          },
          {
            "month": 8,
            "days": [
              1,
              4,
              5,
              6,
              7,
              8,
              11,
              12,
              13,
              14,
              15,
              18,
              19,
              20,
              21,
              22,
              25,
              26,
              27,
              28,
              29
            ]
          },
          {
            "month": 9,
            "days": [
              1,
              2,
              3,
              4,
              5,
              8,
              9,
              10,
              11,
              12,
              15,
              16,
              17,
              18,
              19,
              22,
              23,
              24,
              25,
              26,
              29,
              30
            ]
          },
          {
            "month": 10,
            "days": [
              1,
              2,
              3,
              6,
              7,
              8,
              9,
              10,
              13,
              14,
              15,
              16,
              17,
              20,
              21,
              22,
              23,
              24,
              27,
              28,
              29,
              30,
              31
            ]
          },
          {
            "month": 11,
            "days": [
              3,
              4,
              5,
              6,
              7,
              10,
              11,
              12,
              13,
              14,
              17,
              18,
              19,
              20,
              21,
              24,
              25,
              26,
              27,
              28
            ]
          },
          {
            "month": 12,
            "days": [
              1,
              2,
              3,
              4,
              5,
              8,
              9,
              10,
              11,
              12,
              15,
              16,
              17,
              18,
              19,
              22,
              23,
              24,
              25,
              26,
              29,
              30,
              31
            ]
          }
        ]
      }
    ],
    "NextToken": "eCKqVlS5FKF5EWGGOo8EgQ==",
    "Total": 10,
    "MaxResults": 10
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterParameter error: %s.参数错误: %s
401IllegalRequestIllegalRequest: %s.非法请求:%s
403NoPermissionNo permission to perform this operation: %s.没有权限去执行该操作:%s
404NotFoundNot found: %s.资源不存在:%s
500InternalErrorInternalError: %s.系统内部错误:%s

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

变更历史

变更时间变更内容概要操作
2025-12-25新增 OpenAPI查看变更详情