ListCalendars - 获取日历列表

更新时间:
复制 MD 格式

获取日历列表

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

ClusterId

string

是

集群 ID。

xxljob-b6ec1xxxx

CalendarName

string

否

日历名称

workday

Year

integer

否

年。

2024

FetchCalendarDetail

boolean

否

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

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

  • true:返回每月日历详细天列表。

false

MaxResults

integer

否

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

10

NextToken

string

否

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

eCKqVlS5FKF5EWGGOo8EgQ==

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

3835AA29-2298-5434-BC53-9CC377CDFD2C

Code

integer

响应码。

200

Message

string

错误信息。

Parameter error: content is null.

Success

boolean

是否调用成功。

  • true:调用成功。

  • false:调用失败。

true

Data

object

日历列表及分页信息。

Records

array<object>

数据列表。

object

数据列表。

CalendarName

string

日历名称

workday

Year

integer

年。

2025

Months

string

每个月的日历,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]} ]

NextToken

string

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

eCKqVlS5FKF5EWGGOo8EgQ==

Total

integer

总条数。

10

MaxResults

integer

本次读取的最大数据量,默认值为 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": "[\n  {\"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]},\n  {\"month\":2,\"days\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\n  {\"month\":3,\"days\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},\n  {\"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]},\n  {\"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]},\n  {\"month\":6,\"days\":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},\n  {\"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]},\n  {\"month\":8,\"days\":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},\n  {\"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]},\n  {\"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]},\n  {\"month\":11,\"days\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\n  {\"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]}\n]"
      }
    ],
    "NextToken": "eCKqVlS5FKF5EWGGOo8EgQ==",
    "Total": 10,
    "MaxResults": 10
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter Parameter error: %s. 参数错误: %s
401 IllegalRequest IllegalRequest: %s. 非法请求:%s
500 InternalError InternalError: %s. 系统内部错误:%s
403 NoPermission No permission to perform this operation: %s. 没有权限去执行该操作:%s
404 NotFound Not found: %s. 资源不存在:%s

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

变更历史

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