GetCustomField - : Central de Documentação do Alibaba Cloud

Obtém as informações sobre um campo estendido.

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

eiam:GetCustomField

get

*CustomField

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	idaas_ue2jvisn35ea5lmthk267xxxxx
FieldId	string	Sim	O ID do campo.	ufd_001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
CustomField	object	As informações do campo personalizado.
InstanceId	string	O ID da instância.	idaas_z4pwq7v5ankdimdelzo2zbmzo4
FieldId	string	O ID do campo.	ufd_ncvy5trszg3zajaal5iofauy2q
EntityType	string	O tipo de entidade à qual o campo pertence.	user
FieldName	string	O identificador do campo.	userId
FieldDisplayName	string	O nome de exibição do campo.	userId
FieldDisplayType	string	O tipo de exibição do campo. Valores válidos: input : input. number : number. select : select. checkbox : checkbox.	input
FieldDataType	string	O tipo de dados. Valores válidos: number : number. boolean : boolean. string : string.	string
DefaultValue	string	O valor padrão do campo.	test
FieldDataConfig	object	Os itens de configuração de valor do campo.
Items	array<object>	The list of field configuration items.
	object	The custom field configuration.
DisplayName	string	The display name of the configuration item.	hobby
Value	string	The value of the configuration item.	game
Status	string	The status of the configuration item. Valores válidos: disabled : disabled. enabled : enabled.	enabled
Unique	boolean	Indica se o campo é único.	false
Encrypted	boolean	Indica se o campo é criptografado.	false
Required	boolean	Indica se o campo é obrigatório.	false
UserPermission	string	A permissão do lado do usuário (lado do portal). Valores válidos: read_write : editable. hide : hidden. read_only : visible.	read_only
CreateTime	integer	A hora em que o campo estendido foi criado, no formato de timestamp UNIX. Unidade: milissegundos.	17642960730
UpdateTime	integer	A hora em que o campo estendido foi atualizado pela última vez, no formato de timestamp UNIX. Unidade: milissegundos.	17642960730
Status	string	O status do campo estendido. Valores válidos: disabled : disabled. enabled : enabled.	enabled
Description	string	A descrição do campo estendido.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "CustomField": {
    "InstanceId": "idaas_z4pwq7v5ankdimdelzo2zbmzo4",
    "FieldId": "ufd_ncvy5trszg3zajaal5iofauy2q",
    "EntityType": "user",
    "FieldName": "userId",
    "FieldDisplayName": "userId",
    "FieldDisplayType": "input",
    "FieldDataType": "string",
    "DefaultValue": "test",
    "FieldDataConfig": {
      "Items": [
        {
          "DisplayName": "hobby",
          "Value": "game",
          "Status": "enabled"
        }
      ]
    },
    "Unique": false,
    "Encrypted": false,
    "Required": false,
    "UserPermission": "read_only",
    "CreateTime": 17642960730,
    "UpdateTime": 17642960730,
    "Status": "enabled",
    "Description": "test"
  }
}

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.