文档首页/ 统一身份认证服务 IAM/ API参考/ API/ 区域管理/ 查询区域详情
更新时间：2024-11-18 GMT+08:00
查看PDF
分享

查询区域详情

功能介绍

该接口可以用于查询区域详情。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：地区和终端节点。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/regions/{region_id}

表1 路径参数

参数

是否必选

参数类型

描述

region_id

是

String

待查询的区域ID。可以使用查询区域列表接口获取，控制台获取方法请参见：获取区域ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”。

X-Auth-Token

是

String

IAM用户token(无需特殊权限)。

响应参数

表3 响应Body参数

参数

参数类型

描述

region

Object

区域信息。
表4 region

参数

参数类型

描述

description

String

区域描述信息。

parent_region_id

String

预埋字段，当前无实际意义，返回null。

links

Object

区域的资源链接信息。

locales

Object

区域名，受区域信息注册影响，不一定返回对象中所有字段。

id

String

区域ID。

type

String

区域类型。
表5 region.links

参数

参数类型

描述

self

String

资源链接地址。
表6 region.locales

参数

参数类型

描述

zh-cn

String

区域的中文名称。

en-us

String

区域的英文名称。

pt-br

String

区域的葡萄牙语名称。

es-us

String

区域的美国西班牙语名称。

es-es

String

区域的西班牙语名称。

请求示例

查询区域详情。

GET https://iam.myhuaweicloud.com/v3/regions/{region_id}

响应示例

状态码为 200 时:

请求成功。

{
    "region": {
        "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": "拉美-圣地亚哥",
            "en-us": "LA-Santiago",
            "es-us": "AL-Santiago de Chile1",
            "es-es": "LA-Santiago"
        }
    }
}

返回值

返回值

描述

200

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

405

不允许的方法。

413

请求体过大。

500

内部服务错误。

503

服务不可用。

错误码

无

父主题： 区域管理