GetDataLakePartition API の概要 - DMS

今すぐお試しください

この 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:GetDataLakePartition

get

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CatalogName	string	必須	データカタログ名。	hive
DbName	string	必須	データベース名。	default
TableName	string	必須	テーブル名。	test_table
PartitionValues	array	必須	パーティション値のリスト。
	string	任意	パーティションキー列の値。	part_val1
DataRegion	string	必須	データレイクが存在するリージョン。	cn-hangzhou
Tid	integer	任意	テナント ID。説明コンソール右上のプロフィール画像からテナント ID を取得します。詳細については、「テナント情報の表示」をご参照ください。	3***
WorkspaceId	integer	任意	ワークスペース ID。	12****

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
RequestId	string	リクエスト ID。ログの特定や問題のトラブルシューティングに使用されます。	FE8EE2F1-4880-46BC-A704-5CF63EAF9A04
ErrorCode	string	リクエストが失敗したときに返されるエラーコード。	UnknownError
ErrorMessage	string	呼び出しが失敗したときに返されるエラーメッセージ。	UnknownError
Success	boolean	呼び出しが成功したかどうかを示します。 true：呼び出しは成功しました。 false：呼び出しは失敗しました。	true
Partition	DLPartition	レイクハウスのテーブルパーティション情報。

例

成功レスポンス

JSONJSON

{
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF9A04",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Partition": {
    "TableName": "table_name",
    "Sd": {
      "OriginalColumns": [
        {
          "Comment": "from deserializer",
          "Type": "string",
          "Name": "col"
        }
      ],
      "SortCols": [
        {
          "Order": 1,
          "Col": "col1"
        }
      ],
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "SkewedInfo": {
        "SkewedColValues": [
          [
            "\"123\""
          ]
        ],
        "SkewedColValueLocationMaps": {
          "test": "test",
          "test2": 1
        },
        "SkewedColNames": [
          "col1"
        ]
      },
      "InputFormat": "org.apache.hadoop.mapred.SequenceFileInputFormat",
      "OutputFormat": "org.apache.hadoop.hive.ql.io.HiveSequenceFileOutputFormat",
      "Columns": [
        {
          "Comment": "from deserializer",
          "Type": "string",
          "Name": "col"
        }
      ],
      "IsCompressed": false,
      "SerdeInfo": {
        "SerializationLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
        "DeserializerClass": "org.apache.hadoop.hive.serde2.OpenCSVSerde",
        "Parameters": {
          "serialization.format": "1"
        },
        "Description": "\"serialize\"",
        "SerdeType": 0,
        "SerializerClass": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
        "Name": "name"
      },
      "BucketCols": [
        "2010"
      ],
      "NumBuckets": -1,
      "Location": "oss://xxx"
    },
    "Parameters": {
      "key": "{\"key\":\"value\"}"
    },
    "CreateTime": 1735109884,
    "Values": [
      "part_val1"
    ],
    "CatalogName": "hive",
    "DbName": "default",
    "LastAccessTime": 1608707407
  }
}

エラーコード

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

変更履歴

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