ListContact - Certificate Management Service: Central de Documentação do Alibaba Cloud

Obtém a lista de contatos.

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

yundun-cert:ListContact

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Keyword	string	Não	A palavra-chave de pesquisa. Por exemplo, uma palavra-chave no nome, endereço de e-mail ou número de telefone.	186
ShowSize	integer	Não	O número de contatos a serem exibidos por página em uma consulta paginada.	20
CurrentPage	integer	Não	O número da página atual para paginação. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. O Alibaba Cloud gera um identificador exclusivo para cada solicitação de API. Você pode usar este ID para solucionar problemas.	31C66C7B-671A-4297-9187-2C4477247A74
TotalCount	integer	O número total de resultados da pesquisa.	12
ShowSize	integer	O número de certificados exibidos por página em uma consulta paginada. Valor padrão: 20.	20
CurrentPage	integer	O número da página atual em uma consulta paginada. Valor padrão: 1.	1
Keyword	string	A palavra-chave de correspondência difusa.	186
ContactList	array<object>	A lista de contatos.
	object	O objeto de contato.
ContactId	integer	O ID do contato.	519580
Name	string	O nome do contato.	John.
Mobile	string	O número de telefone celular.	139****8888
MobileStatus	integer	Indica se o número de telefone celular foi verificado.	1
Email	string	O endereço de e-mail do contato.	username@example.com.
EmailStatus	integer	Indica se o endereço de e-mail foi verificado.	1
Webhooks	string	A URL do webhook.	[\"https://open.feishu.cn/open-apis/bot/v2/hook/XXX\",\"https://oapi.dingtalk.com/robot/send?access_token=XXX\",\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX\"]
WebhookList	array	A URL do webhook.
	string	A URL do webhook.	https://open.feishu.cn/open-apis/bot/v2/hook/XXX.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "31C66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount": 12,
  "ShowSize": 20,
  "CurrentPage": 1,
  "Keyword": "186",
  "ContactList": [
    {
      "ContactId": 519580,
      "Name": "John",
      "Mobile": "139****8888",
      "MobileStatus": 1,
      "Email": "username@example.com",
      "EmailStatus": 1,
      "Webhooks": "[\\\"https://open.feishu.cn/open-apis/bot/v2/hook/XXX\\\",\\\"https://oapi.dingtalk.com/robot/send?access_token=XXX\\\",\\\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX\\\"]",
      "WebhookList": [
        "https://open.feishu.cn/open-apis/bot/v2/hook/XXX"
      ]
    }
  ]
}

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.