获取服务下全部域名

最近更新时间：2023.05.26 13:11:19

首次发布时间：2021.02.23 10:42:23

本接口支持通过指定服务 ID 获取服务下所有域名信息。

请求说明

接口名称：GetServiceDomains
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=GetServiceDomains&Version=2018-08-01
请求频率限制：20 次/秒
超时时间：5 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必选描述

Action String 是接口名称。

Version String 是接口版本。veImageX 当前 API 的版本为 2018-08-01。

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

服务 ID。

您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

返回参数

参数	类型	描述
domain	String	域名
cname	String	需要指向的 cname
status	String	域名状态
https_config	Array of https_config	HTTPS 配置
is_default	Bool	是否为默认域名，取值如下所示： true：默认域名 false：非默认域名
resolved	Bool	是否已解析，取值如下所示： true：已解析 false：未解析
user	String	域名申请人
create_time	Integer	创建时间

https_config

参数	类型	描述
enable_https	Bool	是否开启 Https，取值如下所示： true：开启 false：关闭
force_https	Bool	是否强制使用 Https，取值如下所示： true：强制 false：不强制
cert_id	String	证书 ID。

参数

类型

描述

enable_https

Bool

是否开启 Https，取值如下所示：

true：开启
false：关闭

force_https

Bool

是否强制使用 Https，取值如下所示：

true：强制
false：不强制

cert_id

String

证书 ID。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetServiceDomains&Version=2018-08-01&ServieId=*

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetServiceDomains",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
   "Result":[
      {
         "domain":"www.***.cn",
         "cname":"www.***.cn.bytexns.com",
         "status":"正常",
         "region":"中国大陆",
         "https_config":{
            
         },
         "is_default":false,
         "reason":"",
         "user":"test104",
         "security_contact":"",
         "create_time":1664278771
      }
   ]
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetServiceDomains",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "GetServiceDomainsErr",
            "Message": "backend err"
        }
    }
}

错误码

访问公共错误码和域名相关错误码获取详细信息。