查询网络域

最近更新时间: 2026-09-17 00:00:18

1. 接口描述

接口请求域名： bhsaas.api3.fincloud.tencent.cn。

查询网络域

默认接口请求频率限制：20次/秒。

接口更新时间：2025-01-23 14:32:02。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeDomains
Version	是	否	String	公共参数，本接口取值：2019-10-18
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
Limit	否	是	Uint64	每页条目数量，默认20，最大500 示例值： 10
Filters	否	是	Array of Filter	过滤数组示例值：查看
Offset	否	是	Uint64	分页偏移位置，默认值为0 示例值： 0

3. 输出参数

参数名称	类型	描述
TotalCount	Uint64	网络域总数示例值： 1
DomainSet	Array of Domain	网络域列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameterValue	参数取值错误。
InternalError	内部错误。
InvalidFilter	无效的过滤器

5. 示例

示例1 查询网络域

查询网络域

输入示例

POST / HTTP/1.1
Host: bh.cloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomains
<公共请求参数>

{
  "Limit": 10,
  "Offset": 0
}

输出示例

{
  "Response": {
    "DomainSet": [
      {
        "Id": 7,
        "DomainId": "net-vvr396q5",
        "DomainName": "test-net-name",
        "Enabled": 1,
        "Status": 0,
        "ResourceId": "bh-saas-jtvukub4",
        "CreateTime": "2024-04-19T11:11:55+08:00",
        "Default": 0,
          "WhiteIpSet": [
          "127.0.0.1",
          "171.0.0.1"
        ]
      }
    ],
    "RequestId": "sdfsadf-sdfasd-sdfsad-sdf2222",
    "TotalCount": 1
  }
}