GetSQLReviewCheckResultStatus API 概要 - Data Management (DMS)

SQL レビューの実行結果を照会します。

操作説明

SQL レビュー機能の詳細については、「SQL レビュー」をご参照ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:GetSQLReviewCheckResultStatus

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
OrderId	integer	必須	チケット ID です。この値は、CreateSQLReviewOrder 操作のレスポンスパラメーターから取得できます。	123321
Tid	integer	任意	テナント ID です。この値は、GetUserActiveTenant または ListUserTenants 操作を呼び出して取得できます。	1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	リクエストが失敗した場合に返されるエラーコードです。	UnknownError
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージです。	UnknownError
Success	boolean	リクエストが成功したかどうかを示します。	true
CheckResultStatus	object	SQL レビューの結果です。
TotalSQLCount	integer	SQL ステートメントの合計数です。	10
CheckedCount	integer	レビュー済みの SQL ステートメント数です。	10
CheckStatusResult	object	SQL ステートメントのステータスチェック結果です。
New	integer	レビュー対象の SQL ステートメント数です。	0
Unknown	integer	異常な SQL ステートメント数です。	0
CheckNotPass	integer	レビューに不合格となった SQL ステートメント数です。	1
CheckPass	integer	レビューに合格した SQL ステートメント数です。	8
ForcePass	integer	手動レビューで合格した SQL ステートメント数です。	1
ForceNotPass	integer	手動レビューで不合格となった SQL ステートメント数です。	0
SQLReviewResult	object	SQL ステートメントに対する最適化の提案です。
MustImprove	integer	必ず修正が必要な SQL ステートメント数です。	1
PotentialIssue	integer	潜在的な問題を含む SQL ステートメント数です。	0
SuggestImprove	integer	修正を推奨する SQL ステートメント数です。	3
UseDmsToolkit	integer	ロックフリーのスキーマ変更に使用可能な SQL ステートメント数です。	0
UseDmsDmlUnlock	integer	ロックフリーのデータ変更に使用可能な SQL ステートメント数です。	0
TableIndexSuggest	integer	インデックスを使用できる SQL ステートメント数です。	2

例

成功レスポンス

JSONJSON

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "CheckResultStatus": {
    "TotalSQLCount": 10,
    "CheckedCount": 10,
    "CheckStatusResult": {
      "New": 0,
      "Unknown": 0,
      "CheckNotPass": 1,
      "CheckPass": 8,
      "ForcePass": 1,
      "ForceNotPass": 0
    },
    "SQLReviewResult": {
      "MustImprove": 1,
      "PotentialIssue": 0,
      "SuggestImprove": 3,
      "UseDmsToolkit": 0,
      "UseDmsDmlUnlock": 0,
      "TableIndexSuggest": 2
    }
  }
}

エラーコード

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

変更履歴

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