Get Connector API: POST /api/v1/connector/dash/getConnector-Alibaba Cloud Model Studio(Model Studio)-阿里云帮助中心

Query details of a connector. Look up by connector ID or by name; pass at least one.

Prerequisites

You have an Alibaba Cloud Model Studio API key (see the API Key page in the console) and authentication configured. For details, see RAG API overview and Authentication. Data import endpoints use the same base URL and authentication as other RAG APIs, with the path prefix /api/v1/connector/dash/.

Endpoint

POST /api/v1/connector/dash/getConnector

Query details of a connector. Look up by connector ID or by name; pass at least one.

NoteAt least one of connectorId or connectorName must be provided. If both are given, connectorId takes precedence.

Request body

Field	Required	Type	Description
`connectorId`	No	string	Connector ID. Pass at least one of connectorId or connectorName.
`connectorName`	No	string	Connector name. Pass at least one of connectorId or connectorName. At most 20 characters.

Request example

curl -X POST "$BASE_URL/api/v1/connector/dash/getConnector" \
  -H "Authorization: Bearer $BAILIAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connectorId": "conn_abc123"
  }'

BASE_URL is https://{workspace_id}.cn-beijing.maas.aliyuncs.com ({workspace_id} is the Workspace ID), and BAILIAN_API_KEY is your Alibaba Cloud Model Studio API key.

Response example

Returns 200 on success.

{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "connectorId": "conn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
    "connectorName": "默认文件连接器",
    "connectorType": "FILE",
    "connectorSubType": "UNSTRUCTURED",
    "description": "默认文件类型连接器",
    "gmtCreate": "2026-03-16 16:13:26",
    "gmtModified": "2026-03-16 16:13:26"
  },
  "status": 200
}

Response fields

Field	Type	Description
`code`	string	Response code. `Success` on success.
`message`	string	Error or informational message; an empty string on success.
`requestId`	string	Unique request identifier. Include this ID when reporting an issue.
`data`	object	Connector details. Sub-fields: `connectorId` (string, connector ID), `connectorType` (string, connector type. Only FILE is supported), `connectorName` (string, connector name), `description` (string, connector description), `connectorSubType` (string, connector subtype, such as `UNSTRUCTURED`), `gmtCreate` (string, creation time in `YYYY-MM-DD HH:mm:ss` format), `gmtModified` (string, last modified time in `YYYY-MM-DD HH:mm:ss` format).
`status`	integer	Business status code. `200` on success, `400` for failures such as invalid parameters. Note that the HTTP status code remains 200 even on failure, so rely on this field and `code` to determine the result.

Error codes

HTTP status code	Error code `code`	Description
400	`InvalidParameter`	Invalid request parameters. Example `message`: `Required parameter missing or invalid.`
401	`InvalidApiKey`	Authentication failed; the API key is invalid or missing. Example `message`: `Invalid API-key provided.`

On business failures the HTTP status code remains 200. Check status and code in the response body to determine the result.