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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeKBSyncLinks

get

*すべてのリソース。

*

なし

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-beijing
KnowledgeBaseId	string	必須	ナレッジベースの一意の ID。	pkb-xxxxx
ImPlatform	string	任意	同期リンクのソースチャンネル。	FEISHU
PageNumber	integer	任意	クエリ結果のページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページあたりに返される同期リンクの数。有効な値: 10、20、30、50、100、200、500。デフォルト値: 30。	30

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
Items	array<object>	同期リンクのリスト。
	object	同期リンク情報。
ClientId	string	クライアント ID。	cli_xxxxxxbe8
CreationTime	string	作成時間。時間は協定世界時 (UTC) の ISO 8601 形式 (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。	2026-08-11T09:55:19Z
Description	string	同期リンクの説明。	testDesc
ImPlatform	string	同期リンクのソースチャンネル。	FEISHU
LinkId	string	同期リンクの ID。	pkbl-xxxxx
LinkName	string	リンク名。	testName
SourceDir	string	同期用のソースディレクトリのアドレス。	https://example.feishu.cn/wiki/space/xxxxxx
SyncIntervalMinutes	integer	同期間隔。単位: 分。	30
SyncStatus	string	同期ステータス。有効な値: CREATING RUNNING PAUSED DELETING	RUNNING
PageNumber	integer	現在の結果のページ番号。	1
PageSize	integer	現在の結果のページあたりのレコード数。	30
RequestId	string	リクエストの ID。	EB07CFF0-D8A4-5C76-AED7-D00E26FC2***
TotalRecordCount	integer	クエリ条件に一致する同期リンクの総数。	1

例

成功レスポンス

JSONJSON

{
  "Items": [
    {
      "ClientId": "cli_xxxxxxbe8",
      "CreationTime": "2026-08-11T09:55:19Z",
      "Description": "testDesc",
      "ImPlatform": "FEISHU",
      "LinkId": "pkbl-xxxxx",
      "LinkName": "testName",
      "SourceDir": "https://example.feishu.cn/wiki/space/xxxxxx",
      "SyncIntervalMinutes": 30,
      "SyncStatus": "RUNNING"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "EB07CFF0-D8A4-5C76-AED7-D00E26FC2***",
  "TotalRecordCount": 1
}

エラーコード

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

変更履歴

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