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/ Identity and Access Management/ Referência de API/ API/ Gerenciamento de agências/ Listagem de agências

Atualizado em 2024-08-31 GMT+08:00

Ver PDF

Listagem de agências

Função

Esta API é fornecida para que o administrador liste as agências que correspondem às condições especificadas.

A API pode ser chamada usando o ponto de extremidade global e pontos de extremidade da região específica. Para pontos de extremidade do IAM, consulte Regiões e pontos de extremidade.

URI

GET /v3.0/OS-AGENCY/agencies

**Tabela 1** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
domain_id	Sim	String	ID da conta da parte delegante. Para obter detalhes sobre como obter o ID da conta, consulte Obtenção de informações sobre conta, usuário do IAM, grupo, projeto, região e agência. NOTA: domain_id não é necessário se X-Auth-Token estiver definido como um token com permissões refinadas.
name	Não	String	Nome da agência. Para obter detalhes sobre como obter o nome da agência, consulte Obtenção de informações sobre conta, usuário do IAM, grupo, projeto, região e agência.
trust_domain_id	Não	String	ID da conta da parte delegada. Para obter detalhes sobre como obter o ID da conta, consulte Obtenção de informações sobre conta, usuário do IAM, grupo, projeto, região e agência.

Parâmetros de solicitação

**Tabela 2** Parâmetros no cabeçalho da solicitação
Parâmetro	Obrigatório	Tipo	Descrição
Content-Type	Sim	String	Preencha application/json;charset=utf8 nesse campo.
X-Auth-Token	Sim	String	Token com permissões de Security Administrator ou permissões de política.

Parâmetros de resposta

**Tabela 3** Parâmetros no corpo da resposta
Parâmetro	Tipo	Descrição
agencies	Array of objects	Informações da agência.

**Tabela 4** agencies
Parâmetro	Tipo	Descrição
create_time	String	Hora em que a agência foi criada. NOTA: O valor é uma hora UTC no formato AAAA-MM-DDTHH:mm:ss.ssssssZ, por exemplo, 2023-06-28T08:56:33.710000Z. Para obter detalhes sobre os formatos de data e carimbo de data/hora, consulte ISO-8601.
description	String	Descrição da agência.
domain_id	String	ID da conta delegada.
duration	String	Período de validade da agência. FOREVER e null indicam que a agência tem validade ilimitada. ONEDAY indica que a agência é válida apenas por um dia.
expire_time	String	Tempo de expiração da agência. O valor null indica que a agência tem validade ilimitada. NOTA: O valor é uma hora UTC no formato AAAA-MM-DDTHH:mm:ss.ssssssZ, por exemplo, 2023-06-28T08:56:33.710000Z. Para obter detalhes sobre os formatos de data e carimbo de data/hora, consulte ISO-8601.
id	String	ID da agência.
name	String	Nome da agência.
trust_domain_id	String	ID da conta delegada.
trust_domain_name	String	Nome da conta delegada.

Exemplo de solicitação

Solicitação para consultar agências em condições específicas

GET https://iam.myhuaweicloud.com/v3.0/OS-AGENCY/agencies?domain_id=0ae9c6993a2e47bb8c4c7a9bb82...

Exemplo de resposta

Código de status: 200

A solicitação foi bem-sucedida.

{
    "agencies": [
        {
            "create_time": "2020-01-04T03:37:16.000000",
            "description": "",
            "domain_id": "d78cbac186b744899480f25b...",
            "duration": "FOREVER",
            "expire_time": null,
            "id": "0760a9e2a60026664f1fc0031f9f2...",
            "name": "IAMAgency",
            "trust_domain_id": "a2cd82a33fb043dc9304bf72...",
            "trust_domain_name": "IAMDomainB"
        }
    ]
}

Códigos de status

Código de status	Descrição
200	A solicitação foi bem-sucedida.
401	Falha na autenticação.
403	Acesso negado.
404	O recurso solicitado não pode ser encontrado.
500	Erro de servidor interno.