Get Connector

Get the details of a connector.

POST

/api/v1/connector/dash/getConnector

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/getConnector" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connectorId": "conn_abc123"
  }'

{
  "code": "Success",
  "message": "",
  "messageUnmodified": false,
  "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "data": {
    "connectorId": "conn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
    "connectorName": "Default file connector",
    "connectorType": "FILE",
    "connectorSubType": "UNSTRUCTURED",
    "description": "Default connector for file-type data sources",
    "gmtCreate": "2026-03-16 16:13:26",
    "gmtModified": "2026-03-16 16:13:26"
  },
  "status": 200
}

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

Authorizations

string

header

required

DashScope API Key, obtained from the API Key page in the console.

Body

application/json

string

Connector ID. Pass at least one of connectorId or connectorName.

string

Connector name. Pass at least one of connectorId or connectorName.

Required range:length <= 20

Response

200-application/json

string

Response code. Success on success.

string

Error or informational message; an empty string on success.

string

Unique request identifier. Include this ID when reporting an issue.

object

Show child attributes

string

Connector ID.

enum<string>

Connector type. Only FILE is supported.

Available options:FILE

string

Connector name.

string

Connector description.

string

Connector subtype, such as UNSTRUCTURED.

string

Creation time in YYYY-MM-DD HH:mm:ss format.

string

Last modified time in YYYY-MM-DD HH:mm:ss format.

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.

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/getConnector" \ -H "Authorization: Bearer $DASHSCOPE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "connectorId": "conn_abc123" }'

{ "code": "Success", "message": "", "messageUnmodified": false, "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "data": { "connectorId": "conn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx", "connectorName": "Default file connector", "connectorType": "FILE", "connectorSubType": "UNSTRUCTURED", "description": "Default connector for file-type data sources", "gmtCreate": "2026-03-16 16:13:26", "gmtModified": "2026-03-16 16:13:26" }, "status": 200 }