TrafficRoute DNS 套件
TrafficRoute DNS 套件
私网解析
请输入
- 文档首页
TrafficRoute DNS 套件API 参考解析器ResolverListResolverEndpoints - 获取终端节点列表
ListResolverEndpoints - 获取终端节点列表
文档反馈
问问助手获取终端节点的列表。
使用说明
请求频率：每秒最多调用 10 次。
请求说明
- 请求方式：GET
- 请求地址：https://private-zone.volcengineapi.com/?Action=ListResolverEndpoints?Version=2022-06-01
调试
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
const columns = [
{
width: '20%',
title: '参数',
dataIndex: 'Name',
className: 'openapi-doc-parameter-table-name'
},
{
width: 130,
title: '类型',
dataIndex: 'DataType',
className: 'openapi-doc-parameter-table-type'
},
{
width: 90,
title: '是否必填',
dataIndex: 'IsRequired',
className: 'openapi-doc-parameter-table-required'
},
{
width: '20%',
title: '示例值',
dataIndex: 'Example',
className: 'openapi-doc-parameter-table-example'
},
{
title: '描述',
dataIndex: 'Description',
className: 'openapi-doc-parameter-table-description'
},
];
const data = [
{
rowKey: '->Action',
Name: 'Action',
DataType: 'String',
IsRequired: '是',
Example: <RenderMd content={"ListResolverEndpoints"} />,
Description: <RenderMd content={"要执行的操作，取值：ListResolverEndpoints。"} />,
children: [
]
},
{
rowKey: '->Version',
Name: 'Version',
DataType: 'String',
IsRequired: '是',
Example: <RenderMd content={"2022-06-01"} />,
Description: <RenderMd content={"API的版本，取值：2022-06-01。"} />,
children: [
]
},
{
rowKey: '->PageNumber',
Name: 'PageNumber',
DataType: 'Integer',
IsRequired: '否',
Example: <RenderMd content={"1"} />,
Description: <RenderMd content={"页码。API 返回该页码所包含的域名。该参数的默认值是 1。"} />,
children: [
]
},
{
rowKey: '->PageSize',
Name: 'PageSize',
DataType: 'Integer',
IsRequired: '否',
Example: <RenderMd content={"10"} />,
Description: <RenderMd content={"每页包含的域名数量。 系统会将获取的域名进行分页显示。页数是由获取的域名总数和 PageSize 确定。 该参数的默认值是 10，最大值是 500。"} />,
children: [
]
},
{
rowKey: '->TagFilters',
Name: 'TagFilters',
DataType: 'Array of Object',
IsRequired: '否',
Example: <RenderMd content={"TagFilters.1={\"Key\":\"k1\",\"Values\":[\"v1\", \"v2\"]}&TagFilters.2={\"Key\":\"k2\",\"Values\":[\"v1\", \"v2\"]}"} />,
Description: <RenderMd content={"终端节点的标签。您需要指定：\n\n- N：表示 `TagFilters` 的序号，取值范围：1～10。`N` 应按照从小到大的顺序，且必须为连续的数字。\n- 标签键：例如 `\"Key\":\"k1\"`。如果您指定多个标签键，私网解析 PrivateZone 会查询同时包含所有指定标签键的终端节点。\n- 标签值：例如 `Values\":[\"v1\", \"v2\"]`。标签值数组的长度取值范围为 1～3。\n\n您可不传入 `Values`，表示查询时 `Values` 不作为查询条件。如果您把仅包含空字符串的数组传入 `Values` ，私网解析 PrivateZone 会查询 `Values` 为空的标签。如果一个 `Values` 包含多个值，这些值之间的关系为逻辑或（OR）。"} />,
children: [
{
rowKey: '->TagFilters->Key',
Name: 'Key',
DataType: 'String',
IsRequired: '是',
Example: <RenderMd content={"k1"} />,
Description: <RenderMd content={"标签键。"} />,
children: [
]
},
{
rowKey: '->TagFilters->Values',
Name: 'Values',
DataType: 'Array of String',
IsRequired: '否',
Example: <RenderMd content={"[\"v1\", \"v2\"]"} />,
Description: <RenderMd content={"标签值。数组的长度取值范围为 1～3。"} />,
children: [
]
},
]
},
{
rowKey: '->ProjectName',
Name: 'ProjectName',
DataType: 'String',
IsRequired: '否',
Example: <RenderMd content={"default"} />,
Description: <RenderMd content={"终端节点所属的项目名称。如果您不传入该参数，该参数不作为查询条件。"} />,
children: [
]
},
{
rowKey: '->VpcTrns',
Name: 'VpcTrns',
DataType: 'Array of String',
IsRequired: '否',
Example: <RenderMd content={"[\"trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k\"]"} />,
Description: <RenderMd content={"域名所关联的一个或多个 VPC 的 [TRN](https://www.volcengine.com/docs/6257/1134319)。格式为 `trn:vpc:region:accountId:vpc/vpcId`。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。"} />,
children: [
]
},
{
rowKey: '->Name',
Name: 'Name',
DataType: 'String',
IsRequired: '否',
Example: <RenderMd content={"node001\t"} />,
Description: <RenderMd content={"终端节点的名称。如果您不传入该参数，该参数不会作为查询条件。\n"} />,
children: [
]
},
{
rowKey: '->VpcID',
Name: 'VpcID',
DataType: 'String',
IsRequired: '否',
Example: <RenderMd content={"vpc-2bzitkgxxxxxg3ur0cv\t"} />,
Description: <RenderMd content={"终端节点所属的 VPC 的 ID。如果您不传入该参数，该参数不会作为查询条件。\n"} />,
children: [
]
},
{
rowKey: '->Status',
Name: 'Status',
DataType: 'String',
IsRequired: '否',
Example: <RenderMd content={"Updating"} />,
Description: <RenderMd content={"终端节点的状态。\n- Creating：创建中。\n- Running：运行中。\n- Updating：更新中。\n- Error：运行异常。\n如果您不传入该参数，该参数不会作为查询条件。"} />,
children: [
]
},
{
rowKey: '->Direction',
Name: 'Direction',
DataType: 'String',
IsRequired: '否',
Example: <RenderMd content={"OUTBOUND"} />,
Description: <RenderMd content={"终端节点的 DNS 请求转发方向。如果您不设置该参数，列表中会同时包含出站终端节点和入站终端节点。\n- OUTBOUND：出站终端节点，把来自 VPC 内的 DNS 查询请求转发到外部的 DNS 服务器。\n- INBOUND：入站终端节点，把来自外部的 DNS 查询请求转发到解析器。"} />,
children: [
]
},
];
return (<Table
rowKey="rowKey"
className="openapi-doc-parameter-table"
columns={columns}
data={data}
border={ { cell: true, wrapper: true } }
scroll={ { x: "auto" } }
pagination={false}
/>);
返回参数
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
const columns = [
{
width: '25%',
title: '参数',
dataIndex: 'Name',
className: 'openapi-doc-parameter-table-name',
},
{
width: 130,
title: '类型',
dataIndex: 'DataType',
className: 'openapi-doc-parameter-table-type'
},
{
width: '25%',
title: '示例值',
dataIndex: 'Example',
className: 'openapi-doc-parameter-table-example'
},
{
title: '描述',
dataIndex: 'Description',
className: 'openapi-doc-parameter-table-description'
},
];
const data = [
{
rowKey: "->Endpoints",
Name: "Endpoints",
DataType: "Array of Object",
Example: <RenderMd content={"无"} />,
Description: <RenderMd content={"终端节点信息"} />,
children: [
{
rowKey: "->Endpoints->ID",
Name: "ID",
DataType: "Integer",
Example: <RenderMd content={"123"} />,
Description: <RenderMd content={"终端节点的 ID。"} />,
children: [
]
},
{
rowKey: "->Endpoints->CreatedAt",
Name: "CreatedAt",
DataType: "String",
Example: <RenderMd content={"2023-06-16T11:07:21+08:00"} />,
Description: <RenderMd content={"终端节点的创建时间。"} />,
children: [
]
},
{
rowKey: "->Endpoints->UpdatedAt",
Name: "UpdatedAt",
DataType: "String",
Example: <RenderMd content={"2023-06-16T11:07:21+08:00"} />,
Description: <RenderMd content={"终端节点的更新时间。"} />,
children: [
]
},
{
rowKey: "->Endpoints->Name",
Name: "Name",
DataType: "String",
Example: <RenderMd content={"abc"} />,
Description: <RenderMd content={"终端节点的名称。"} />,
children: [
]
},
{
rowKey: "->Endpoints->Direction",
Name: "Direction",
DataType: "String",
Example: <RenderMd content={"OUTBOUND"} />,
Description: <RenderMd content={"终端节点的 DNS 请求转发方向。\n\n- OUTBOUND：出站终端节点，把来自 VPC 内的 DNS 查询请求转发到外部的 DNS 服务器。\n- INBOUND：入站终端节点，把来自外部的 DNS 查询请求转发到解析器。"} />,
children: [
]
},
{
rowKey: "->Endpoints->Status",
Name: "Status",
DataType: "String",
Example: <RenderMd content={"Creating"} />,
Description: <RenderMd content={"终端节点的状态。\n\n- Creating：创建中。\n- Running：运行中。\n- Updating：更新中。\n- Error：运行异常。"} />,
children: [
]
},
{
rowKey: "->Endpoints->VpcID",
Name: "VpcID",
DataType: "String",
Example: <RenderMd content={"vpc-123456"} />,
Description: <RenderMd content={"终端节点所在的出站 VPC 的 ID。"} />,
children: [
]
},
{
rowKey: "->Endpoints->VpcRegion",
Name: "VpcRegion",
DataType: "String",
Example: <RenderMd content={"cn-beijing"} />,
Description: <RenderMd content={"终端节点所在的出站 VPC 的地域。"} />,
children: [
]
},
{
rowKey: "->Endpoints->SecurityGroupID",
Name: "SecurityGroupID",
DataType: "String",
Example: <RenderMd content={"sg-2bzixxxxxef6zlelm"} />,
Description: <RenderMd content={"适用于终端节点 IP 地址的安全组 ID。"} />,
children: [
]
},
{
rowKey: "->Endpoints->ProjectName",
Name: "ProjectName",
DataType: "String",
Example: <RenderMd content={"default"} />,
Description: <RenderMd content={"终端节点所属的项目名称。"} />,
children: [
]
},
{
rowKey: "->Endpoints->Tags",
Name: "Tags",
DataType: "Array of Object",
Example: <RenderMd content={"无"} />,
Description: <RenderMd content={"终端节点所属的一个或多个标签。"} />,
children: [
{
rowKey: "->Endpoints->Tags->Key",
Name: "Key",
DataType: 'String',
Example: <RenderMd content={"key"} />,
Description: <RenderMd content={"标签的键。"} />,
children: [
]
},
{
rowKey: "->Endpoints->Tags->Value",
Name: "Value",
DataType: 'String',
Example: <RenderMd content={"value"} />,
Description: <RenderMd content={"标签的值。"} />,
children: [
]
},
]
},
{
rowKey: "->Endpoints->IpConfigs",
Name: "IpConfigs",
DataType: "Array of Object",
Example: <RenderMd content={"无"} />,
Description: <RenderMd content={"终端节点的可用区、子网和 IP 配置。"} />,
children: [
{
rowKey: "->Endpoints->IpConfigs->AzID",
Name: "AzID",
DataType: 'String',
Example: <RenderMd content={"xxxxxx-b"} />,
Description: <RenderMd content={"终端节点 IP 地址所在的可用区。"} />,
children: [
]
},
{
rowKey: "->Endpoints->IpConfigs->SubnetID",
Name: "SubnetID",
DataType: 'String',
Example: <RenderMd content={"subnet-2bzitxxxxxef1mtmn6"} />,
Description: <RenderMd content={"终端节点 IP 地址所在的子网 ID。"} />,
children: [
]
},
{
rowKey: "->Endpoints->IpConfigs->IP",
Name: "IP",
DataType: 'String',
Example: <RenderMd content={"192.168.0.2"} />,
Description: <RenderMd content={"终端节点的 IPv4 地址。"} />,
children: [
]
},
{
rowKey: "->Endpoints->IpConfigs->IPv6",
Name: "IPv6",
DataType: 'String',
Example: <RenderMd content={"1dc9:cd46:f3f5:29f6:e700:2780:e6ad:1dfa\n\n"} />,
Description: <RenderMd content={"终端节点的 IPv6 地址。"} />,
children: [
]
},
]
},
]
},
{
rowKey: "->Total",
Name: "Total",
DataType: "Integer",
Example: <RenderMd content={"10"} />,
Description: <RenderMd content={"终端节点总数。"} />,
children: [
]
},
{
rowKey: "->PageNumber",
Name: "PageNumber",
DataType: "Integer",
Example: <RenderMd content={"1"} />,
Description: <RenderMd content={"页码。\n"} />,
children: [
]
},
{
rowKey: "->PageSize",
Name: "PageSize",
DataType: "Integer",
Example: <RenderMd content={"10"} />,
Description: <RenderMd content={"每页包含的转发节点的数量。\n"} />,
children: [
]
},
];
return (<Table
rowKey="rowKey"
className="openapi-doc-parameter-table"
columns={columns}
data={data}
border={ { cell: true, wrapper: true } }
scroll={ { x: "auto" } }
pagination={false}
/>);
请求示例
GET https://private-zone.volcengineapi.com/?Action=ListResolverEndpoints&Version=2022-06-01
返回示例
{
"ResponseMetadata": {
"RequestId": "20230616141900294A2272398E16B6FEB6",
"Action": "ListResolverEndpoints",
"Version": "2022-06-01",
"Service": "private_zone",
"Region": "cn-north-1"
},
"Result": {
"Endpoints": [
{
"ID": 238,
"CreatedAt": "2023-06-16T11:07:21+08:00",
"UpdatedAt": "2023-06-16T11:07:54+08:00",
"Name": "xxxx",
"Status": "Running",
"Direction": "OUTBOUND",
"VpcID": "vpc-2bzitxxxxxxxeg3ur0cv",
"VpcRegion": "xxxxxx",
"SecurityGroupID": "sg-2bzixxxxxef6zlelm",
"IpConfigs": [
{
"AzID": "xxxxxx-a",
"SubnetID": "subnet-2bzitxxxxxef1mtmn6",
"IP": "192.168.0.2"
},
{
"AzID": "xxxxxx-b",
"SubnetID": "subnet-2bzitxxxxxx2dx0effff81i",
"IP": "192.168.1.2"
}
],
"ProjectName": "default",
"Tags": [
{
"Key": "key",
"Value": "value"
}
]
}
],
"PageNumber": 1,
"PageSize": 20,
"Total": 1
}
}
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
const columns = [
{
title: '状态码',
dataIndex: 'HttpCode',
width: '12%',
className: 'openapi-doc-errorcode-table-httpcode'
},
{
title: '错误码',
dataIndex: 'ErrorCode',
width: '22%',
className: 'openapi-doc-errorcode-table-errorcode'
},
{
title: '错误信息',
dataIndex: 'ErrorMessage',
width: '33%',
className: 'openapi-doc-errorcode-table-errormessage'
},
{
title: '说明',
dataIndex: 'Description',
width: '33%',
className: 'openapi-doc-errorcode-table-description'
},
];
const data = [
{
HttpCode: 500,
ErrorCode: 'ErrInternalServer',
ErrorMessage: <RenderMd content={"server internal error"} />,
Description: <RenderMd content={"服务内部错误"} />,
},
];
return (<Table
columns={columns}
data={data}
border={ { cell: true, wrapper: true } }
scroll={ { x: "auto" } }
pagination={false}
/>);
最近更新时间：2025.05.22 20:09:55
这个页面对您有帮助吗？
有用
有用
无用
无用