You need to enable JavaScript to run this app.
导航

DescribeCloudConnectors

最近更新时间2024.01.09 07:43:30

首次发布时间2024.01.09 07:43:30

调用DescribeCloudConnectors符合条件的云连接器实例的信息。

调用说明

DescribeCloudConnectors支持分页查询,初次调用接口进行分页查询时,仅需传入MaxResults以限制单页返回结果的条目,无需传入NextToken,查询结果会返回NextToken的值作为后续页查询的凭证。后续查询时请求参数NextToken传入上一次的NextToken的返回值,并设置MaxResults限制单页返回结果的条目即可。

请求参数

名称类型是否必选示例值描述
ActionStringDescribeCloudConnectors要执行的操作,取值:DescribeCloudConnectors。
VersionString2020-04-01API版本信息。

CloudConnectorIds.N

String

CloudConnectorIds.1=cc-1sdsf334j51288****&CloudConnectorIds.2=cc-e3dfrgrek89a****

云连接器实例的ID。

  • 参数 - N:表示云连接器实例ID的序号,数量上限为100个。

  • 如不填,则默认查询当前账号下符合条件的全部云连接器实例。

  • 多个云连接器实例ID间使用“&”分隔。

CloudConnectorNameStringcciot-cc云连接器实例的名称。

ISP

String

ChinaTelecom

线路类型。

  • ChinaTelecom:中国电信。

  • ChinaMobile:中国移动。

  • ChinaUnicom:中国联通。

APNStringxxx.mcc.mnc.gprs云连接器使用的APN。您可调用DescribeCloudConnectorAPNs查询APN信息。
VpcIdStringvpc-sd232dsf****云连接器绑定的VPC的ID。

MaxResults

String

50

单次查询的数量,默认为 10,最大为100。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

分页查询凭证,用于标记分页的位置。
初次调用接口时无需设置,后续查询此参数取值为上一次API调用返回的NextToken的值。

返回数据

名称类型示例值描述
RequestIdString20220627103212010225145152058****请求ID。

NextToken

String

ca3fob2be03f84eb41b633f0d****

本次调用返回的查询凭证值,返回为空表示没有下一页。

CloudConnectorsArray of struct-云连接器实例列表,见下方“CloudConnector”。

CloudConnector

名称类型示例值描述
CloudConnectorIdStringcc-1sdsf334j51288****云连接器实例的ID。
CloudConnectorNameStringcciot-cc云连接器实例的名称。
DescriptionStringcciot-decription云连接器实例的描述。
APNIdStringapn-1sdsf334j51288****运营商APN的ID。

ISP

String

ChinaUnicom

运营商类型。

  • ChinaTelecom:中国电信。

  • ChinaMobile:中国移动。

  • ChinaUnicom:中国联通。

VpcIdStringvpc-sd232dsf****云连接器实例绑定的VPC的ID。

SubnetIds.N

List of String

["subnet-2fe74yvngdukg5oxruwgq****","subnet-1g0f7rju1txj48ibuxxob****"]

云连接器实例绑定的VPC下子网的ID列表。

Status

String

Available

APN的状态。

  • Creating:创建中

  • Deleting:删除中

  • Pending:操作中

  • Available:可用

  • Deleted:已删除

CreationTimeString2021-07-12T07:28:20+08:00创建云连接器的时间。

BusinessStatus

String

Normal

云连接器是否被锁定。

  • Normal: 正常。

  • FinancialLocked: 被锁定。

OverdueTimeString2021-04-29 01:00:00资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
DeletedTimeString2021-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错误码错误信息描述
400DryRunOperationException raised to indicate a successfully authorized action when the DryRun flag is set to true.该请求设置为DryRun操作,操作授权已获得许可,但未被实际执行。
400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.CloudConnectorFilterIdsYou've reached the limit on the number of cloud connector filter IDs that you can describe.已达到可查询的云连接器筛选条件ID数量上限。