GetExtension - DataWorks: Central de Documentação do Alibaba Cloud

Obtém os detalhes de uma extensão específica.

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.

Testar

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 Action das 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 Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
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

dataworks:*

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ExtensionCode	string	Sim	O código exclusivo da extensão.	ce4*********086da5

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado da resposta.
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	0000-ABCD-EFG
Extension	object	Os detalhes da extensão.
ExtensionCode	string	O código exclusivo da extensão.	ce4*********086da5
ExtensionName	string	O nome da extensão.	Extension name
ExtensionDesc	string	A descrição da extensão.	This is a description
HelpDocUrl	string	A URL da documentação de ajuda da extensão.	https://www.aliyun.com/
Status	integer	O status da extensão. Valores válidos: 0: em teste 1: online 3: desativado 4: aprovação pendente 5: aprovado 6: rejeitado	0
ProjectTesting	integer	O workspace usado para testes. Quando a extensão está no estado de teste, apenas o workspace de teste pode usar a extensão.	1355211
DetailUrl	string	A URL da página de detalhes da extensão. Os usuários da extensão podem usar esta URL para visualizar os detalhes do processo bloqueado.	https://www.aliyun.com/
ParameterSetting	string	As configurações de parâmetros. Para mais informações, consulte Configurações de parâmetros da extensão.	extension.project.disabled=projectId1,projectId2,projectId3
OptionSetting	string	As configurações de opções.	Option configuration
BindEventList	array<object>	A lista de pontos de extensão.
	object	Os detalhes do ponto de extensão.
EventCode	string	O código de evento do ponto de extensão.	commit-file
EventName	string	O nome do evento do ponto de extensão.	File submission pre-event
EventCategoryList	array<object>	A lista de tipos de evento.
	object	Os detalhes do tipo de evento.
CategoryCode	string	O código do tipo de evento.	file-change
CategoryName	string	O nome do tipo de evento.	File change event

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0000-ABCD-EFG",
  "Extension": {
    "ExtensionCode": "ce4*********086da5",
    "ExtensionName": "Extension name",
    "ExtensionDesc": "This is a description",
    "HelpDocUrl": "https://www.aliyun.com/",
    "Status": 0,
    "ProjectTesting": 1355211,
    "DetailUrl": "https://www.aliyun.com/",
    "ParameterSetting": "extension.project.disabled=projectId1,projectId2,projectId3",
    "OptionSetting": "Option configuration",
    "BindEventList": [
      {
        "EventCode": "commit-file",
        "EventName": "File submission pre-event"
      }
    ],
    "EventCategoryList": [
      {
        "CategoryCode": "file-change",
        "CategoryName": "File change event"
      }
    ]
  }
}

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.