Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Meeting/ Referência de API do servidor/ Gerenciamento do administrador empresarial/ APIs/ Consulta de administradores empresariais em páginas
Atualizado em 2023-08-02 GMT+08:00
Ver PDF
Compartilhar

Consulta de administradores empresariais em páginas

Descrição

Esta API é usada para consultar administradores empresariais em páginas.

SLA

Taxa de sucesso de solicitação: > 99,99%

Atraso na solicitação TP99: 445 ms

Depuração

Você pode depurar essa API no API Explorer.

Protótipo

Tabela 1 Protótipo

Método de solicitação

GET

Endereço de solicitação

/v1/usg/dcs/corp/admin

Protocolo de transporte

HTTPS

Parâmetros de solicitação

Tabela 2 Parâmetros

Parâmetro

Obrigatório

Tipo

Localização

Descrição

offset

Não

Integer

Consulta

Deslocamento de consulta. Se o valor exceder o número máximo de registros disponíveis, os registros na última página serão retornados.

limit

Não

Integer

Consulta

Número de registros para consultar.

Valor padrão: 10.

searchKey

Não

String

Consulta

Critérios de pesquisa. Pesquisa difusa por nome, número de celular, endereço de e-mail, conta e ID de conta de terceiros é suportada.

X-Access-Token

Sim

String

Cabeçalho

Token de autorização. Use o valor de accessToken na resposta à solicitação de Autenticação de um ID de aplicação.

X-Request-Id

Não

String

Cabeçalho

ID da solicitação, que é usado para rastreamento e localização de falhas. É aconselhável usar um UUID. Se este parâmetro não for transportado, um ID de solicitação é gerado automaticamente.

Accept-Language

Não

String

Cabeçalho

Idioma. Valores: zh-CN para chinês (padrão) e en-US para inglês.

Códigos de status

Tabela 3 Códigos de status

Código de status HTTP

Descrição

200

Operação bem-sucedida.

400

Parâmetros inválidos.

401

A autenticação não é executada ou falha.

403

Permissões insuficientes.

500

Exceção do servidor.

Parâmetros de resposta

Tabela 4 Parâmetros de resposta

Parâmetro

Tipo

Descrição

count

Integer

Número total de registros.

limit

Integer

Número de registros exibidos por página.

Valor padrão: 10.

offset

Integer

Número da página inicial da consulta. O valor começa em 0.

data

Array of QueryAdminResultDTO objects

Detalhes retornados sobre administradores empresariais.
Tabela 5 Parâmetros de QueryAdminResultDTO

Parâmetro

Tipo

Descrição

account

String

Conta de administrador.

adminType

Integer

Tipo de administrador.

  • 0: administrador padrão.
  • 1: administrador comum.

country

String

País ou região a que o número de telemóvel pertence.

dept

DeptBasicDTO object

Detalhes básicos do departamento.

email

String

Endereço de e-mail.

id

String

ID do usuário.

name

String

Nome do administrador.

phone

String

Número de celular.
Tabela 6 Parâmetros de DeptBasicDTO

Parâmetro

Tipo

Descrição

corpId

String

ID da empresa.

deptCode

String

Código do departamento.

deptName

String

Nome do departamento.

deptNamePath

String

Caminho do nome do departamento.

parentDeptCode

String

Código do departamento de pais.

Exemplo de solicitação

GET /v1/usg/dcs/corp/admin
Connection: keep-alive
X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U
content-type: application/json
Content-Length: 40
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Exemplo de resposta

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: efd3e53b2d9fa554d11267d5d66ca0bf

{
    "offset": 0,
    "limit": 10,
    "count": 1,
    "data": [
        {
            "id": "ff8080816a024f05016a4e1c2c570a5d",
            "account": "test006",
            "name": "test006",
            "adminType": 1,
            "email": "menmeng1@huawei.com",
            "phone": null,
            "country": null,
            "dept": null
        }
    ]
}

Códigos de erro

Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas no Centro de erros da API da Huawei Cloud.

Exemplo de comando cURL

curl -k -i -X GET -H 'X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/admin
Tópico principal: APIs