调用GetSchedule获取发送计划详情_人工智能平台 PAI(PAI)-阿里云帮助中心

获取发送计划详细信息，包括计划时间、内容、状态等。

调试

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

授权信息

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

请求语法

GET /api/v2/schedules/{Id} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Id	string	否	触达计划 ID。如何获取触达计划 ID，请参见 ListSchedules 。	0bddaf8f-5628-427a-8652-5e24f6b4c35d

返回参数

名称	类型	描述	示例值
	object	成功获取触达计划详情。
Data	object	返回数据。
CreatedTime	string	创建时间 (UTC+8)。	2020-01-01 12:00:00
EndTime	string	终止时间（UTC+8）。	2020-01-01
ExecuteTime	string	执行时间 (UTC+8)，为空立即执行。	2020-01-01 12:00:00
GroupId	string	人群 ID。	0a54e195-03e2-40bd-869d-b71cb302783e
History	string	历史记录。	string
Id	string	触达计划 ID。	0a54e195-03e2-40bd-869d-b71cb302783e
Name	string	触达计划名称。	增长-2021-0101
RepeatCycle	integer	重复周期，按重复周期与重复周期单位执行。	0
RepeatCycleUnit	integer	重复周期单位，若指定执行时间（ExecuteTime），则重复周期生效。可能值： 0：从不（默认）。 1：小时。 2：天。 3：周。 4：月。	0
RepeatTimes	integer	重复次数，可能值： -1：不设终止时间（默认）。 0：不重复。 N：重复 N 次后终止。	-1
SignName	string	签名。	PAI
SignatureId	string	签名 ID。	0a54e195-03e2-40bd-869d-b71cb302783e
Status	integer	状态，可能值： 0：检查中。 1：检查成功。 2：检查失败。 3：发送中。 4：发送成功。 5：发送失败。	0
TemplateCode	string	模板 Code。	SMS_123456
TemplateId	string	模板 ID。	0a54e195-03e2-40bd-869d-b71cb302783e
UpdatedTime	string	更新时间 (UTC+8)。	2020-01-01 12:00:00
PaymentType	string	计费类型（为空时默认后付费），可能值为： PayAsYouGo：后付费（按量付费） Subscription：预付费（包年包月）	Subscription
ErrorCode	integer	错误码。	0
ErrorMessage	string	错误信息。	OK
RequestId	string	请求 ID。	f8651828-609d-4de8-ab49-ab781d7fd85a

示例

正常返回示例

JSON格式

{
  "Data": {
    "CreatedTime": "2020-01-01 12:00:00",
    "EndTime": "2020-01-01",
    "ExecuteTime": "2020-01-01 12:00:00",
    "GroupId": "0a54e195-03e2-40bd-869d-b71cb302783e",
    "History": "string",
    "Id": "0a54e195-03e2-40bd-869d-b71cb302783e",
    "Name": "增长-2021-0101",
    "RepeatCycle": 0,
    "RepeatCycleUnit": 0,
    "RepeatTimes": -1,
    "SignName": "PAI",
    "SignatureId": "0a54e195-03e2-40bd-869d-b71cb302783e",
    "Status": 0,
    "TemplateCode": "SMS_123456",
    "TemplateId": "0a54e195-03e2-40bd-869d-b71cb302783e",
    "UpdatedTime": "2020-01-01 12:00:00",
    "PaymentType": "Subscription"
  },
  "ErrorCode": 0,
  "ErrorMessage": "OK",
  "RequestId": "f8651828-609d-4de8-ab49-ab781d7fd85a"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-03-09	OpenAPI 返回结构发生变更	查看变更详情