获取区域信息
功能介绍
该API用于获取AI开发平台ModelArts-在线服务的区域信息。当创建自定义接入点的“source”参数选择“custom_from_modelarts_v2”时,获取请求中的region参数。
接口约束
该功能仅支持“西南-贵阳一”区域。
URI
GET /v1/{project_id}/maas/services/custom-endpoint/regions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project-id |
是 |
String |
参数解释:项目ID。关于如何获取项目ID,请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:只能由小写英文字母和数字组成,长度为32。 默认取值:不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释:用户Token。通过调用IAM服务的获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取方式请参见认证鉴权。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
Content-Type |
是 |
String |
参数解释:消息体的类型,固定为application/json。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
region_items |
Array[RegionInfo] |
参数解释:AI开发平台ModelArts-在线服务所有的Region信息。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
region_id |
String |
参数解释:AI开发平台ModelArts-在线服务的Region。 取值范围:不涉及。 |
|
locales |
LocalInfo |
参数解释:接入点中英文名称。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
en_us |
String |
参数解释:英文名称。 取值范围:不涉及。 |
|
zh_cn |
String |
参数解释:中文名称。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
参数解释:错误描述信息。 取值范围:不涉及。 |
|
error_code |
String |
参数解释:错误码,标识错误类型。 取值范围:不涉及。 |
请求示例
GET
/v1/{project_id}/maas/services/custom-endpoint/regions
响应示例
- 成功响应,状态码:200。
{ "region_items": [ { "region_id": "cn-southwest-2", "locales": { "en_us": "cn-southwest-2", "zh_cn": "贵阳一" } }, { "region_id": "cn-north-12", "locales": { "en_us": "cn-north-12", "zh_cn": "华北三" } }, { "region_id": "cn-east-4", "locales": { "en_us": "cn-east-4", "zh_cn": "华东二" } }, { "region_id": "cn-north-9", "locales": { "en_us": "cn-north-9", "zh_cn": "乌兰察布一" } } ] } - 错误响应,状态码:400。
{ "error_msg": "Invalid token.", "error_code": "ModelArts.0104" }
状态码
请参见状态码。
错误码
请参见错误码。