Obtém detalhes sobre um conector. Esta operação atualmente suporta apenas conectores de arquivo.
Descrição da operação
- Para chamar esta operação, um usuário RAM (subconta) deve ter as permissões de API necessárias para o Alibaba Cloud Model Studio e deve ingressar em um espaço de negócios. Isso requer a política
AliyunBailianDataFullAccess, que inclui a permissão sfm:GetConnector. Uma conta Alibaba Cloud (conta principal) pode chamar esta operação diretamente. Recomendamos usar o SDK do Alibaba Cloud Model StudioSDK do Alibaba Cloud Model Studio mais recente para chamar esta operação. - Esta operação é idempotente.
Limitação de taxa: Esta operação está sujeita a limitação de taxa. Não exceda a frequência de 5 chamadas por segundo. Se uma solicitação for limitada, tente novamente mais tarde.
Experimente agora
Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.
Autorização RAM
A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:
-
Ação: As ações que podem ser usadas no elemento
Actiondas instruções de política de permissão do RAM para conceder permissões para executar a operação. -
API: A API que você pode chamar para executar a ação.
-
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
-
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento
Resourceda política. - Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento
Resourceda política.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento
-
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
-
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.
Ação | Nível de acesso | Tipo de recurso | Chave de condição | Ação dependente |
|---|---|---|---|---|
sfm:GetConnector | get | *All Resource
| Nenhuma | Nenhuma |
Sintaxe da solicitação
GET /{WorkspaceId}/datacenter/connector HTTP/1.1
Parâmetros de caminho
Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| WorkspaceId | string | Sim | O ID do espaço de negócios. Para obter este ID, consulte Usar espaços de negócios. | llm-3z7uw7fwz0vxxxx |
Parâmetros da solicitação
Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| ConnectorName | string | Não | O nome do conector a ser consultado. É necessária uma correspondência exata. | 连接器名称 |
| ConnectorId | string | Não | O ID do conector. Você pode encontrar este ID no console do Model Studio. | conn_file_xxxx |
Elementos de resposta
Elemento | Tipo | Descrição | Exemplo |
|---|---|---|---|
object | O objeto de resposta. | ||
| Code | string | O código de resultado. | success |
| Data | object | Os dados retornados. | |
| ConnectorId | string | O ID do conector. | conn_file_e0c9db4030b2465a9478028f7d76cd92_1234 |
| ConnectorName | string | O nome do conector. | name |
| ConnectorType | string | O tipo do conector. | FILE |
| Description | string | A descrição do conector. | Description |
| Message | string | A mensagem de erro. | Requests throttling triggered. |
| RequestId | string | O ID da solicitação. | 7BA8ADD9-53D6-53F0-918F-A1E776AD230E |
| Status | string | O código de status da resposta. | 200 |
| Success | boolean | Indica se a solicitação foi bem-sucedida. Valores válidos:
| True |
Exemplos
Resposta de sucesso
JSON formato
{
"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
}
Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.