获取服务下全部域名--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取服务下全部域名

最近更新时间：2024.03.11 20:34:09首次发布时间：2021.02.23 10:42:23

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

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间约为 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetServiceDomains&Version=2018-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述

Action String 是 GetServiceDomains 接口名称。当前 API 的名称为 GetServiceDomains。

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

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

ServiceId

String

是

89**0j

服务 ID。

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
domain	String	`www.***.cn`	域名
cname	String	`www.***.cn.bytexns.com`	指向的 cname 值
status	String	`正常`	域名状态
region	String	`中国大陆`	地域
https_config	Object of Https_config	`-`	HTTPS 配置
is_default	Boolean	`false`	是否是默认域名，取值如下所示： `true`：默认域名 `false`：非默认域名
reason	String	`域名存在特殊配置`	域名锁定原因
user	String	`test104`	域名申请人
create_time	Float	`1664278771`	创建时间
lock_status	Object of Lock_status		域名锁定状态

Lock_status

参数	类型	示例值	描述
domain_locked	Boolean	`true`	整个域名是否锁定，取值如下所示： `true`：是，您无法手动修改其配置。如需修改，请提交工单联系技术支持。 `false`：否
compression_locked	Boolean	`true`	智能压缩是否锁定，取值如下所示： `true`：是 `false`：否
ip_access_rule_locked	Boolean	`true`	IP 访问限制是否锁定，取值如下所示： `true`：是 `false`：否
referer_access_rule_locked	Boolean	`true`	Referer 防盗链是否锁定，取值如下所示： `true`：是 `false`：否
remote_auth_locked	Boolean	`true`	远程鉴权是否锁定，取值如下所示： `true`：是 `false`：否
response_header_locked	Boolean	`true`	响应头是否锁定，取值如下所示： `true`：是 `false`：否
sign_url_auth_locked	Boolean	`true`	URL 鉴权是否锁定，取值如下所示： `true`：是 `false`：否
ua_access_rule_locked	Boolean	`true`	UA 访问限制是否锁定，取值如下所示： `true`：是 `false`：否

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetServiceDomains&Version=2018-08-01&ServiceId=89**0j

返回示例

{
  "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": "test",
      "create_time": 1664278771,
      "lock_status": {
            "domain_locked": true,
            "compression_locked": true,
            "ip_access_rule_locked": true,
            "referer_access_rule_locked": false,
            "response_header_locked": true,
            "sign_url_auth_locked": false,
            "ua_access_rule_locked": false
        }
    }
  ]
}

错误码

访问公共错误码以及通用错误码获取详细信息。