GetScheduledSQL - - Alibaba Cloud ドキュメントセンター

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

log:GetScheduledSQL

get

*All Resource

*

なし

リクエスト構文

GET /scheduledsqls/{scheduledSQLName} HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
project	string	必須	プロジェクト名。	ali-test-project
scheduledSQLName	string	必須	既存のタスクの一意な名前。	sql-123456789-123456

レスポンスフィールド

フィールド	型	説明	例
	ScheduledSQL	Scheduled SQL タスクの構成。

例

成功レスポンス

JSONJSON

{
  "description": "This is a scheduled sql job",
  "displayName": "This is a scheduled sql job",
  "name": "test-scheduled-sql",
  "schedule": {
    "type": "Cron",
    "cronExpression": "0/5 * * * *",
    "runImmediately": false,
    "timeZone": "+0800",
    "delay": 4,
    "interval": "1m"
  },
  "configuration": {
    "script": "* | select *",
    "sqlType": "searchQuery",
    "destEndpoint": "cn-hangzhou-intranet.log.aliyuncs.com",
    "destProject": "project-demo",
    "sourceLogstore": "source-logstore-demo",
    "destLogstore": "dest-logstore-demo",
    "roleArn": "acs:ram::123456789:role/aliyunlogetlrole",
    "destRoleArn": "acs:ram::123456789:role/aliyunlogetlrole",
    "fromTimeExpr": "@m-1m",
    "toTimeExpr": "@m",
    "maxRunTimeInSeconds": 600,
    "resourcePool": "enhanced",
    "maxRetries": 20,
    "fromTime": 1712592000,
    "toTime": 0,
    "dataFormat": "log2log",
    "parameters": {
      "test": "test",
      "test2": 1
    }
  },
  "createTime": 1714123644,
  "lastModifiedTime": 1714123644,
  "scheduleId": "e73f43732852064ad5d091914e39342f",
  "status": "ENABLED"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
401	AuthorizationRequired	Authorization Required

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

変更履歴

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