すべてのプロダクト
Search

このプロダクト

    CloudFlow:DescribeSchedule

    ドキュメントセンター

    CloudFlow:DescribeSchedule

    最終更新日:Dec 20, 2025

    時間ベースのスケジュールの詳細情報を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    fnf:DescribeSchedule

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FlowName

    string

    必須

    時間ベースのスケジュールに関連付けられているフローの名前。名前はリージョン内で一意である必要があり、時間ベースのスケジュールが作成された後は変更できません。名前は、次の規則を満たす必要があります。

    • 名前に使用できるのは、英字、数字、アンダースコア (_)、ハイフン (-) です。

    • 名前は英字またはアンダースコア (_) で始める必要があります。

    • 名前では大文字と小文字が区別されます。

    • 名前の長さは 1～128 文字である必要があります。

    testFlowName
    ScheduleName

    string

    必須

    時間ベースのスケジュールの名前。名前は、次の規則を満たす必要があります。

    • 名前に使用できるのは、英字、数字、アンダースコア (_)、ハイフン (-) です。

    • 名前は英字またはアンダースコア (_) で始める必要があります。

    • 名前では大文字と小文字が区別されます。

    • 名前の長さは 1～128 文字である必要があります。

    testScheduleName

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ。

    RequestId

    string

    リクエスト ID。

    testRequestId
    Description

    string

    時間ベースのスケジュールの説明。

    test description
    ScheduleId

    string

    時間ベースのスケジュールの ID。

    testScheduleId
    Payload

    string

    時間ベースのスケジュールのトリガーメッセージ。

    {"key": "value"}
    ScheduleName

    string

    時間ベースのスケジュールの名前。

    testScheduleName
    CreatedTime

    string

    時間ベースのスケジュールが作成された時間。

    2020-01-01T01:01:01.001Z
    LastModifiedTime

    string

    時間ベースのスケジュールが最後に変更された時間。

    2020-01-01T01:01:01.001Z
    CronExpression

    string

    CRON 式。

    0 * * * * *
    Enable

    boolean

    時間ベースのスケジュールが有効かどうかを示します。有効な値：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "testRequestId",
  "Description": "test description",
  "ScheduleId": "testScheduleId",
  "Payload": "{\"key\": \"value\"}",
  "ScheduleName": "testScheduleName",
  "CreatedTime": "2020-01-01T01:01:01.001Z",
  "LastModifiedTime": "2020-01-01T01:01:01.001Z",
  "CronExpression": "0 * * * * *",
  "Enable": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 ActionNotSupported The requested API operation '%s' is incorrect. Please check.
    400 APIVersionNotSupported The requested API version '%s' is not supported yet. Please check.
    400 InvalidArgument Parameter error.
    400 MissingRequiredHeader The HTTP header '%s' must be specified.
    400 MissingRequiredParams The HTTP query '%s' must be specified.
    500 InternalServerError An internal error has occurred. Please retry.
    403 AccessDenied The resources doesn't belong to you.
    404 FlowNotExists Flow %s does not exist.
    404 ScheduleNotExists The schedule %s for flow %s does not exist.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。