ListCalendars-阿里云帮助中心

Retrieves a list of calendars.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster.	xxljob-b6ec1xxxx
CalendarName	string	No	The name of the calendar.	workday
Year	integer	No	The year.	2024
FetchCalendarDetail	boolean	No	Specifies whether to return calendar details. The default value is `false`. `false`: Does not return the detailed list of days for each month. Only basic information is returned. `true`: Returns the detailed list of days for each month.	false
MaxResults	integer	No	The maximum number of entries returned per page. The default value is 10.	10
NextToken	string	No	The token to retrieve the next page of results. Set this parameter to the `NextToken` value from the previous response. Omit this parameter for the first request.	eCKqVlS5FKF5EWGGOo8EgQ==

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The ID of the request.	3835AA29-2298-5434-BC53-9CC377CDFD2C
Code	integer	The response code.	200
Message	string	The error message.	Parameter error: content is null.
Success	boolean	Indicates whether the request was successful. true: The request succeeded. false: The request failed.	true
Data	object	The returned data.
Records	array<object>	A list of calendars.
	object	The details of a calendar.
CalendarName	string	The name of the calendar.	workday
Year	integer	The year.	2025
Months	string	A JSON string that represents an array of months and their corresponding days.	[ {"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	The token for the next page of results. If this parameter is not returned, all results have been retrieved.	eCKqVlS5FKF5EWGGOo8EgQ==
Total	integer	The total number of entries.	10
MaxResults	integer	The maximum number of entries returned per page.	10

Examples

Success response

JSON format

{
  "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
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Parameter error: %s.	Parameter error: %s
401	IllegalRequest	IllegalRequest: %s.	Illegal request:%s
500	InternalError	InternalError: %s.	System Internal Error: %s
403	NoPermission	No permission to perform this operation: %s.	No permission to perform this operation: %s
404	NotFound	Not found: %s.	The resource does not exist: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.