接口介绍
查询内外网访问endpoint
接口约束
- 支持的线上资源池 :上海7、南京3、南京5、杭州2、合肥2、九江、广州6、武汉4、福州25、厦门3、郴州2、海口2、北京5、雄安2、石家庄20、内蒙6、晋中、辽阳1、西安5、乌鲁木齐4、乌鲁木齐27、中卫5、兰州2、西宁2、拉萨3、昆明2、重庆2、成都4、贵州3、上海33、宁波边缘云、华东1、上海36、南昌5、青岛20、武汉41、长沙42、长沙37、南宁23、北京行业云20、华北2、西南1、上海32。
- 自2024年8月21日后,响应参数"intranetEndpoint"将会支持返回对象存储内网域名。即当该资源池支持通过内网域名方式访问对象存储后,"intranetEndpoint"将由原先固定返回内网IP地址(如"http://100.127.154.200"),改为返回内网域名(如https://shanghai-15-internal.zos.ctyun.cn)。
- 当前已有杭州7、华北2、上海15支持内网域名;如需通过内网域名访问对象存储,请注意将云主机/裸金属的默认DNS,指向天翼云内网DNS。详情请见:更改主机DNS使内网DNS配置生效。
URI
GET /v4/oss/get-endpoint
请求参数
请求 Query 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
regionID | 是 | String | 区域ID | 332232eb-63aa-465e-9028-52e5123866f0 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
description | String | 状态描述,一般为中文 | 成功 |
returnObj | Object | 响应对象 | 见下级对象 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
ipv6Endpoint | Array of String | 内网ipv6列表,未配置时为空 | null |
intranetEndpoint | Array of String | 内网ipv4列表,未配置时为空 注:2024年8月21日后,对于杭州7、华北2、上海15资源池,本参数会返回内网域名; 其他资源池会返回内网IP地址 |
["http://100.127.154.200"] ["https://shanghai-15-internal.zos.ctyun.cn"] |
internetEndpoint | Array of String | 外网ipv4列表,未配置时为空 | ["http://100.124.255.6:80"] |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/get-endpoint?regionID=332232eb-63aa-465e-9028-52e5123866f0
响应示例
{
"returnObj": {
"ipv6Endpoint": null,
"intranetEndpoint": [
"http://100.127.154.200"
],
"internetEndpoint": [
"http://100.124.255.6:80"
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表