DescribeAccessPoints - - Alibaba Cloud ドキュメントセンター

特定のリージョンにある Express Connect 回線のアクセスポイントを照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	DescribeAccessPoints	実行する操作。値を DescribeAccessPoints に設定します。
RegionId	String	はい	cn-hangzhou	アクセスポイントのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。
PageNumber	Integer	いいえ	1	返すページ番号。デフォルト値: 1。
PageSize	Integer	いいえ	10	1 ページあたりに返すエントリの数。最大値: 50。デフォルト値: 10。
AcceptLanguage	String	いいえ	zh-CN	レスポンスの言語。有効な値: zh-CN: 中国語 en-US (デフォルト): 英語

レスポンスパラメーター

パラメーター	タイプ	例	説明
RequestId	String	3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027	リクエスト ID。
PageNumber	Integer	1	返されたページのページ番号。デフォルト値: 1。
PageSize	Integer	10	1 ページあたりに返されるエントリの数。最大値: 50。デフォルト値: 10。
TotalCount	Integer	5	返されたエントリの数。
AccessPointSet	AccessPointType の配列		アクセスポイントに関する情報。
AccessPointType
Status	String	recommended	アクセスポイントのステータス。有効な値: recommended: アクセスポイントは使用できる状態です。 hot: 多数の Express Connect 回線がアクセスポイントに接続されています。 full: アクセスポイントに接続されている Express Connect 回線数が上限に達しました。 disabled: アクセスポイントは使用できません。
Type	String	VPC	Express Connect 回線のネットワークタイプ。デフォルト値: VPC。
HostOperator	String	China Telecom	アクセスポイントのインターネットサービスプロバイダー (ISP)。有効な値:
Description	String	Access point description	アクセスポイントの説明。
AttachedRegionNo	String	cn-hangzhou	アクセスポイントのリージョン ID。
Name	String	Hangzhou-Yuhang-C	アクセスポイントの名前。
AccessPointId	String	ap-cn-hangzhou-****	アクセスポイントの ID。
Location	String	Hangzhou	アクセスポイントの場所。
AccessPointFeatureModels	AccessPointFeatureModel の配列		アクセスポイントの機能モデル。
AccessPointFeatureModel
FeatureValue	String	true	アクセスポイントの機能値。
FeatureKey	String	AP_Support_VbrBandwidthLimit	アクセスポイントの機能。

例

リクエストの例

http(s)://[エンドポイント]/?Action=DescribeAccessPoints
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&AcceptLanguage=zh-CN
&共通リクエストパラメーター

正常なレスポンスの例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAccessPointsResponse>
    <RequestId>3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>5</TotalCount>
    <AccessPointSet>
        <Status>recommended</Status>
        <Type>VPC</Type>
        <HostOperator>China Telecom</HostOperator>
        <Description>Access point description</Description>
        <AttachedRegionNo>cn-hangzhou</AttachedRegionNo>
        <Name>Hangzhou-Yuhang-C</Name>
        <AccessPointId>ap-cn-hangzhou-****</AccessPointId>
        <Location>Hangzhou</Location>
        <AccessPointFeatureModels>
            <FeatureValue>true</FeatureValue>
            <FeatureKey>AP_Support_VbrBandwidthLimit</FeatureKey>
        </AccessPointFeatureModels>
    </AccessPointSet>
</DescribeAccessPointsResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 5,
  "AccessPointSet" : [ {
    "Status" : "recommended",
    "Type" : "VPC",
    "HostOperator" : "China Telecom",
    "Description" : "Access point description",
    "AttachedRegionNo" : "cn-hangzhou",
    "Name" : "Hangzhou-Yuhang-C",
    "AccessPointId" : "ap-cn-hangzhou-****",
    "Location" : "Hangzhou",
    "AccessPointFeatureModels" : [ {
      "FeatureValue" : "true",
      "FeatureKey" : "AP_Support_VbrBandwidthLimit"
    } ]
  } ]
}

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
404	InvalidRegionId.NotSupport	The RegionId provided does not support in our records.	指定されたリージョン ID が無効なために返されたエラーメッセージ。

エラーコードの一覧については、API エラーセンターをご参照ください。