GetConnector

Operation description

To call this operation, a RAM user (sub-account) must have the required API permissions for Alibaba Cloud Model Studio and must join a business space. This requires the AliyunBailianDataFullAccess policy, which includes the sfm:GetConnector permission. An Alibaba Cloud account (primary account) can call this operation directly. We recommend using the latest Alibaba Cloud Model Studio SDK Alibaba Cloud Model Studio SDK to call this operation.
This operation is idempotent.

Throttling: This operation is subject to throttling. Do not exceed a frequency of 5 calls per second. If a request is throttled, try again later.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sfm:GetConnector

get

*All Resource

*

None

Request syntax

GET /{WorkspaceId}/datacenter/connector HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The ID of the business space. To obtain this ID, see Use business spaces.	llm-3z7uw7fwz0vxxxx

Request parameters

Parameter	Type	Required	Description	Example
ConnectorName	string	No	The name of the connector to query. An exact match is required.	连接器名称
ConnectorId	string	No	The ID of the connector. You can find this ID in the Model Studio console.	conn_file_xxxx

Response elements

Element	Type	Description	Example
	object	The response object.
Code	string	The result code.	success
Data	object	The returned data.
ConnectorId	string	The ID of the connector.	conn_file_e0c9db4030b2465a9478028f7d76cd92_1234
ConnectorName	string	The name of the connector.	name
ConnectorType	string	The type of the connector.	FILE
Description	string	The description of the connector.	Description
Message	string	The error message.	Requests throttling triggered.
RequestId	string	The request ID.	7BA8ADD9-53D6-53F0-918F-A1E776AD230E
Status	string	The status code of the response.	200
Success	boolean	Indicates whether the request was successful. The valid values are: `true`: The call was successful. `false`: The call failed.	True

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.