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 regiões> Consulta de regiões

Atualizado em 2023-02-16 GMT+08:00

Ver PDF

Consulta de regiões

Função

Essa API é usada para consultar as regiões acessíveis a um usuário especificado.

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

URI

GET /v3/regions

Parâmetros de solicitação

**Tabela 1** Parâmetros no cabeçalho da solicitação
Parâmetro	Obrigatoriedade	Tipo	Descrição
Content-Type	Sim	String	Preencha application/json;charset=utf8 neste campo.
X-Auth-Token	Sim	String	Token de usuário do IAM (sem requisitos de permissão especiais). Se o token não contiver informações de região privada, nenhuma região privada será devolvida.

Parâmetros de resposta

**Tabela 2** Parâmetros no corpo da resposta
Parâmetro	Tipo	Descrição
links	Object	Informações sobre o link do recurso.
regions	Array of objects	Informações da região.

**Tabela 3** links
Parâmetro	Tipo	Descrição
self	String	Link de recursos.
previous	String	Link do recurso anterior.
next	String	Próximo link de recurso.

**Tabela 4** regions
Parâmetro	Tipo	Descrição
description	String	Descrição da região.
parent_region_id	String	Nulo.
links	Object	Link de recursos da região.
locales	Object	Nome da região.
id	String	ID da região.
type	String	Tipo de região.

**Tabela 5** regions.links
Parâmetro	Tipo	Descrição
self	String	Link de recursos.

**Tabela 6** regions.locales
Parâmetro	Tipo	Descrição
zh-cn	String	Nome da região em chinês.
en-us	String	Nome da região em inglês.
pt-br	String	Nome da região em português.
es-us	String	Nome da região em espanhol americano.
es-es	String	Nome da região em espanhol.

Exemplo de solicitação

GET https://iam.myhuaweicloud.com/v3/regions

Exemplo de resposta

Código de status: 200

A solicitação foi bem-sucedida.

{
    "regions": [
        {
            "parent_region_id": null,
            "description": "",
            "links": {
                "self": "https://iam.myhuaweicloud.com/v3/regions/ap-southeast-1"
            },
            "type": "public",
            "id": "ap-southeast-1",
            "locales": {
                "zh-cn": "CN-Hong Kong",
                "en-us": "ap-southeast-1"
            }
        },
        {
            "parent_region_id": null,
            "description": "",
            "links": {
                "self": "https://iam.myhuaweicloud.com/v3/regions/la-south-2"
            },
            "type": "public",
            "id": "la-south-2",
            "locales": {
                "pt-br": "AL-Santiago",
                "zh-cn": "Region name in Chinese",
                "en-us": "LA-Santiago",
                "es-us": "AL-Santiago de Chile1",
                "es-es": "LA-Santiago"
            }
        }
    ],
    "links": {
        "self": "https://iam.myhuaweicloud.com/v3/regions",
        "previous": null,
        "next": null
    }
}

Códigos de status

Código de status	Descrição
200	A solicitação foi bem-sucedida.
400	Parâmetros inválidos.
401	Autenticação falhou.
403	Acesso negado.
404	O recurso solicitado não pode ser encontrado.
405	O método especificado na solicitação não é permitido para o recurso solicitado.
413	A entidade de solicitação é muito grande.
500	Erro de servidor interno.
503	Serviço indisponível.