获取终端节点的列表。
除了以下参数,您还需要 对请求进行鉴权。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListResolverEndpoints | API 的名称。该参数的取值是 ListResolverEndpoints 。 |
Version | String | 是 | 2022-06-01 | 表示 API 的版本。该参数的取值是 2022-06-01 。 |
Name | String | 否 | node001 | 终端节点的名称。如果您不传入该参数,该参数不会作为查询条件。 |
VpcID | String | 否 | vpc-2bzitkgxxxxxg3ur0cv | 终端节点所属的 VPC 的 ID。如果您不传入该参数,该参数不会作为查询条件。 |
Status | String | 否 | Updating | 终端节点的状态。
|
Direction | String | 否 | OUTBOUND | 终端节点的 DNS 请求转发方向。如果您不设置该参数,列表中会同时包含出站终端节点和入站终端节点。
|
PageNumber | Integer | 否 | 1 | 页码。页数由获取的终端节点总数和 PageSize 确定。默认为 1。 |
PageSize | Integer | 否 | 10 | 每页包含的终端节点的数量。默认为 10。返回结果会将获取的终端节点进行分页显示。页数由获取的终端节点总数和 PageSize 确定。 |
ProjectName | String | 否 | default | 终端节点所属的项目名称。如果您不传入该参数,该参数不作为查询条件。 |
TagFilters.N | String | 否 | TagFilters.1={"Key":"k1","Values":["v1", "v2"]}&TagFilters.2={"Key":"k2","Values":["v1", "v2"]} | 终端节点的标签。您需要指定:
Values ,表示查询时 Values 不作为查询条件。如果您把仅包含空字符串的数组传入 Values ,私网解析 PrivateZone 会查询 Values 为空的标签。如果一个 Values 包含多个值,这些值之间的关系为逻辑或(OR)。 |
名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 标识本次请求的 ID。 |
Action | String | Action 查询参数的值。 |
Version | String | API 版本。 |
Service | String | 服务类型。 |
Region | String | 服务所在地域。 |
名称 | 类型 | 描述 |
---|---|---|
Endpoints | Array of Objects | 终端节点的详细信息。 |
PageNumber | Integer | 页码。 |
PageSize | Integer | 每页包含的终端节点的数量。 |
Total | Integer | 终端节点的总数。 |
GET https://open.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": []
}
],
"PageNumber": 1,
"PageSize": 20,
"Total": 1
}
}
您可访问公共错误码,获取详细信息。