调用DescribeCloudConnectors查询符合条件的云连接器实例的信息。
DescribeCloudConnectors支持分页查询，初次调用接口进行分页查询时，仅需传入MaxResults以限制单页返回结果的条目，无需传入NextToken，查询结果会返回NextToken的值作为后续页查询的凭证。后续查询时请求参数NextToken传入上一次的NextToken的返回值，并设置MaxResults限制单页返回结果的条目即可。
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeCloudConnectors | 要执行的操作，取值：DescribeCloudConnectors。 |
| Version | String | 是 | 2020-04-01 | API版本信息。 |
CloudConnectorIds.N | String | 否 | CloudConnectorIds.1=cc-1sdsf334j51288****&CloudConnectorIds.2=cc-e3dfrgrek89a**** | 云连接器实例的ID。
|
| CloudConnectorName | String | 否 | cciot-cc | 云连接器实例的名称。 |
ISP | String | 否 | ChinaTelecom | 线路类型。
|
| APN | String | 否 | xxx.mcc.mnc.gprs | 云连接器使用的APN。您可调用DescribeCloudConnectorAPNs查询APN信息。 |
| VpcId | String | 否 | vpc-sd232dsf**** | 云连接器绑定的VPC的ID。 |
MaxResults | String | 否 | 50 | 单次查询的数量，默认为 10，最大为100。 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a**** | 分页查询凭证，用于标记分页的位置。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 20220627103212010225145152058**** | 请求ID。 |
NextToken | String | ca3fob2be03f84eb41b633f0d**** | 本次调用返回的查询凭证值，返回为空表示没有下一页。 |
| CloudConnectors | Array of struct | - | 云连接器实例列表，见下方“CloudConnector”。 |
CloudConnector
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| CloudConnectorId | String | cc-1sdsf334j51288**** | 云连接器实例的ID。 |
| CloudConnectorName | String | cciot-cc | 云连接器实例的名称。 |
| Description | String | cciot-decription | 云连接器实例的描述。 |
| APNId | String | apn-1sdsf334j51288**** | 运营商APN的ID。 |
ISP | String | ChinaUnicom | 运营商类型。
|
| VpcId | String | vpc-sd232dsf**** | 云连接器实例绑定的VPC的ID。 |
SubnetIds.N | List of String | ["subnet-2fe74yvngdukg5oxruwgq****","subnet-1g0f7rju1txj48ibuxxob****"] | 云连接器实例绑定的VPC下子网的ID列表。 |
Status | String | Available | APN的状态。
|
| CreationTime | String | 2021-07-12T07:28:20+08:00 | 创建云连接器的时间。 |
BusinessStatus | String | Normal | 云连接器是否被锁定。
|
| OverdueTime | String | 2021-04-29 01:00:00 | 资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。 |
| DeletedTime | String | 2021-04-30 01:00:00 | 预期资源强制回收时间。 |
Zones | List of String | ["cn-beijing-a,cn-beijing-b"] | 云连接器APN的子网所在可用区。 |
GET /?Action=DescribeCloudConnectors&Version=2020-04-01&CloudConnectorIds.1=cc-12bjay8vxvl6o17q7y2h***** HTTP/1.1 Host: open.volcengineapi.com ServiceName: directconnect Region: cn-beijing
{ "ResponseMetadata": { "RequestId": "20240103143724538075683F01163****", "Action": "DescribeCloudConnectors", "Version": "2020-04-01", "Service": "directconnect", "Region": "cn-beijing" }, "Result": { "RequestId": "20240103143724538075683F01163****", "NextToken": "", "CloudConnectors": [ { "CloudConnectorId": "cc-12bjay8vxvl6o17q7y2h****", "CloudConnectorName": "test", "Description": "test", "APNId": "apn-12b8o4l8zx7uo17q7y29****", "ISP": "ChinaUnicom", "VpcId": "vpc-2femkfaiigohs59gp67j****", "SubnetIds": [ "subnet-imzfo1enkikg8gbssz6****", "subnet-12arter49yolc17q7y2****" ], "Zones": [ "cn-beijing-a", "cn-beijing-b" ], "Status": "Available", "CreationTime": "2021-07-12T07:28:20+08:00", "BusinessStatus": "Normal", "OverdueTime": "", "DeletedTime": "" } ] } }
此处仅展示当前API的错误码，更多错误码请参见公共错误码。
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | DryRunOperation | Exception raised to indicate a successfully authorized action when the DryRun flag is set to true. | 该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。 |
| 400 | InvalidMaxResults.Malformed | The specified parameter MaxResults is malformed. | 查询数量不合法。 |
| 400 | InvalidNextToken.Malformed | The specified parameter NextToken is invalid. | 查询 NextToken 不合法。 |
| 400 | InvalidPage.Malformed | The specified page is malformed. | 指定的分页参数不合法。 |
| 400 | LimitExceeded.CloudConnectorFilterIds | You've reached the limit on the number of cloud connector filter IDs that you can describe. | 已达到可查询的云连接器筛选条件ID数量上限。 |