查询可用域名

查询指定区域中可用的域名。

请求 URL

GET {base_url}/dm/open_api/v1/cluster/domains

请求参数

请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
查询参数
参数 是否必填 类型 描述
regionIds 是 Array <Integer> 区域的 ID。
注： 可使用 查询可用区域 查询区域 ID。

响应参数

参数 类型 描述
data Array <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
regionId Integer 区域 ID。
domainId Integer 域名 ID。
domain String 域名。

示例

请求示例

查询区域 A (ID：3) 和区域 B (ID：4) 中的可用域名。
GET /dm/open_api/v1/cluster/domains?regionIds=3,4 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQyNzU2MjV9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0Mjc3NDI1LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiIyM2QyOTk1ZS02ODhkLTRmYWEtYTM5Zi1hNGJlMzNiMzlmZjIiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.xMTMXwuhVOy9xlZ8CDVLt7gxRPHQ6evJ9SQdO1NDsKI
响应示例
HTTP/1.1 200 OK
{
  "data": [
    {
      "regionId": 4,
      "domainId": 1,
      "domain": "test.yeastarcloud.com"
    },
    {
      "regionId": 4,
      "domainId": 2,
      "domain": "test2.yeastarcloud.com"
    },
    {
      "regionId": 4,
      "domainId": 3,
      "domain": "test3.yeastarcloud.com"
    },
    {
      "regionId": 4,
      "domainId": 4,
      "domain": "test4.yeastarcloud.com"
    }
  ],
  "requestId": "431153be-6f82-4667-9723-853311af410a",
  "status": "Success",
  "time": 1664275635
}