コネクタの詳細を取得します。現在、この操作はファイルコネクタにのみ対応しています。
操作説明
- この操作を呼び出すには、RAM ユーザー (サブアカウント) は Alibaba Cloud Model Studio に必要な API 権限を持ち、ビジネススペースに参加している必要があります。これには、
AliyunBailianDataFullAccess権限を含む sfm:GetConnector ポリシーが必要です。Alibaba Cloud アカウント (プライマリアカウント) は、この操作を直接呼び出すことができます。この操作の呼び出しには、最新の Alibaba Cloud Model Studio SDKAlibaba Cloud Model Studio SDK の使用を推奨します。 - この操作はべき等です。
スロットリング: この操作にはスロットリングが適用されます。呼び出し頻度が 1 秒あたり 5 回を超えないようにしてください。リクエストがスロットリングされた場合は、時間をおいて再度お試しください。
今すぐお試しください
この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。
RAM 認証
下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。
-
アクション:特定のリソースに対して実行可能な操作。ポリシー構文では
Action要素として指定します。 -
API:アクションを具体的に実行するための API。
-
アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。
-
リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
Resource要素で対応する ARN を指定してください。 - リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーの
Resource要素でアスタリスク (*) でマークされます。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
-
条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
-
依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。
アクション | アクセスレベル | リソースタイプ | 条件キー | 依存アクション |
|---|---|---|---|---|
sfm:GetConnector | get | *All Resource
| なし | なし |
リクエスト構文
GET /{WorkspaceId}/datacenter/connector HTTP/1.1
パスパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| WorkspaceId | string | 必須 | ビジネススペースの ID。この ID を取得する方法については、「ビジネススペースの利用」をご参照ください。 | llm-3z7uw7fwz0vxxxx |
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| ConnectorName | string | 任意 | 照会するコネクタの名前。完全一致が必須です。 | 连接器名称 |
| ConnectorId | string | 任意 | コネクタの ID。この ID は Model Studio コンソールで確認できます。 | conn_file_xxxx |
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
object | レスポンスオブジェクト。 | ||
| Code | string | 結果コード。 | success |
| Data | object | 返されたデータ。 | |
| ConnectorId | string | コネクタの ID。 | conn_file_e0c9db4030b2465a9478028f7d76cd92_1234 |
| ConnectorName | string | コネクタの名前。 | name |
| ConnectorType | string | コネクタのタイプ。 | FILE |
| Description | string | コネクタの説明。 | Description |
| Message | string | エラーメッセージ。 | Requests throttling triggered. |
| RequestId | string | リクエスト ID。 | 7BA8ADD9-53D6-53F0-918F-A1E776AD230E |
| Status | string | レスポンスのステータスコード。 | 200 |
| Success | boolean | リクエストが成功したかどうかを示します。有効な値は次のとおりです:
| True |
例
成功レスポンス
JSONJSON
{
"Code": "success",
"Data": {
"ConnectorId": "conn_file_e0c9db4030b2465a9478028f7d76cd92_1234",
"ConnectorName": "name",
"ConnectorType": "FILE",
"Description": "Description"
},
"Message": "Requests throttling triggered.",
"RequestId": "7BA8ADD9-53D6-53F0-918F-A1E776AD230E",
"Status": "200",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。