DescribeColdStorageInstance API リファレンス - PolarDB

コールドストレージインスタンスの詳細を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeColdStorageInstance

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	任意	PolarDB クラスターの ID。	pc-wz9062015ly7526jc
NextToken	string	任意	次のページの結果を取得するためのトークンです。このパラメーターには、前の呼び出しで返された `NextToken` の値を設定します。最初の呼び出しでは、このパラメーターを指定する必要はありません。	c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
TableName	string	任意	データテーブルの名前。	account_log
DBName	string	任意	データベースの名前。	test_db
EngineType	string	任意	サポートされているエンジンのタイプ。戻り値は、サポートされているエンジンタイプの値の合計です。 1：検索エンジン 2：LindormTSDB 4：LindormTable 8：ファイルエンジン説明例えば、`EngineType` が 15 (8 + 4 + 2 + 1) の場合、インスタンスは検索エンジン、LindormTSDB、LindormTable、およびファイルエンジンをサポートします。`EngineType` が 6 (4 + 2) の場合、インスタンスは LindormTSDB と LindormTable をサポートします。	2
RegionId	string	任意	リージョン ID。説明詳細については、「DescribeRegions」をご参照ください。このパラメーターを指定しない場合、操作はアカウント内のすべてのリージョンのスケジュールされたタスクを照会します。	cn-hangzhou
MaxResults	integer	任意	MaxResults パラメーターを指定しない場合、クエリはページ分割されません。応答の MaxResults パラメーターの値は、エントリの総数を示します。 MaxResults パラメーターを指定すると、クエリはページ分割されます。MaxResults は、各ページで返すエントリ数を指定します。有効値：1～100。応答の MaxResults パラメーターの値は、現在のページのエントリ数を示します。推奨値は 20 です。	50
ExpireTime	integer	任意	クラスターの有効期限です。注意：このパラメーターはサブスクリプションのクラスターに対してのみ返されます。従量課金のクラスターの場合は、空の値が返されます。	2020-11-14T16:00:00Z
PageNumber	string	任意	ページ番号。	1
PageSize	string	任意	1ページあたりのエントリ数。	1
ObjectType	string	任意	オブジェクトタイプ。有効値：`TABLE`、`PARTITION_TABLE`、および `LOB`。	TABLE

レスポンスフィールド

フィールド	型	説明	例
	object
PageRecordCount	integer	現在のページのエントリ数。	1
RequestId	string	リクエスト ID。	C7A8EA8E-A140-5226-90D7-5BCB304D3DB6
NextToken	string	次のページの結果を取得するためのトークン。このパラメーターが返されない場合、すべての結果が返されたことを示します。	c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
OssClusterEnabled	string	OSS バケットが有効になっているかどうかを示します。 true：有効 false：無効	true
SupportOssCluster	string	クラスターがコールドストレージをサポートしているかどうかを示します。クラスターがコールドストレージをサポートしていない場合、スイッチはコンソールに表示されません。	true
ObjectType	string	オブジェクトタイプ。	TABLE
MaxResults	integer	返されるエントリの最大数。デフォルト値：10。	1000
PageSize	integer	1ページあたりのエントリ数。	30
PageNumber	integer	ページ番号。	1
TotalRecord	integer	エントリの総数。	1
Tables	array<object>	コールドストレージインスタンスのリスト。
	array<object>	コールドストレージインスタンス。
OssClusterId	string	OSS ベースのクラスターの ID。	pc-*****************
Partion	string	コールドストレージインスタンスのパーティション。	202509
Size	string	コールドストレージインスタンスのディスクサイズ。単位：GB。	30
DB	string	データベース名。	test_db
Table	string	テーブル名。	user
TableName	string	テーブル名。	test_table
DBName	string	データベース名。	test_db
Status	string	タスクのステータス。	Running
FieldName	string	ラージオブジェクト (LOB) フィールドの名前。	user
ChildObjects	array<object>	子オブジェクトのリスト。
	object	子オブジェクト。
ObjectName	string	オブジェクト名。	img/1728554006462.png
ObjectType	string	オブジェクトタイプ。	File
Size	string	ディスクサイズ。単位：GB。	10
Status	string	タスクのステータス。有効値： Scheduled：タスクは実行を待機しています。 Running：タスクは進行中です。 Succeed：タスクは成功しました。 Cancelling：タスクは停止中です。 Canceled：タスクは停止しました。 Waiting：タスクはプリセットされた時間を待機しています。複数のステータスを照会する場合は、コンマ (,) で区切ります。このパラメーターを指定しない場合、すべてのステータスが照会されます。	Running
OssClusterInfoList	array<object>	コールドストレージインスタンスの OSS アドレスのリスト。
	object	コールドストレージインスタンスの OSS アドレス。
OssClusterId	string	コールドストレージインスタンスの ID。	pc-*****************
Region	string	タスクが配置されているリージョンの ID。	cn-hangzhou
Size	string	コールドストレージテーブルのサイズ。単位：GB。	50
CreatedTime	string	クラスターが作成された時間。	2023-05-10T17:01:16Z

例

成功レスポンス

JSONJSON

{
  "PageRecordCount": 1,
  "RequestId": "C7A8EA8E-A140-5226-90D7-5BCB304D3DB6",
  "NextToken": "c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==",
  "OssClusterEnabled": "true",
  "SupportOssCluster": "true",
  "ObjectType": "TABLE",
  "MaxResults": 1000,
  "PageSize": 30,
  "PageNumber": 1,
  "TotalRecord": 1,
  "Tables": [
    {
      "OssClusterId": "pc-*****************",
      "Partion": "202509",
      "Size": "30",
      "DB": "test_db",
      "Table": "user",
      "TableName": "test_table",
      "DBName": "test_db",
      "Status": "Running",
      "FieldName": "user",
      "ChildObjects": [
        {
          "ObjectName": "img/1728554006462.png",
          "ObjectType": "File",
          "Size": "10",
          "Status": "Running"
        }
      ]
    }
  ],
  "OssClusterInfoList": [
    {
      "OssClusterId": "pc-*****************",
      "Region": "cn-hangzhou",
      "Size": "50",
      "CreatedTime": "2023-05-10T17:01:16Z"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist
400	Account.QueryError	Instance %s query account error
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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