ListVpcGatewayEndpoints - Virtual Private Cloud - Alibaba Cloud ドキュメントセンター

ゲートウェイエンドポイントをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EndpointId	string	任意	ゲートウェイエンドポイントの ID です。	vpce-bp1i1212ss2whuwyw****
EndpointName	string	任意	ゲートウェイエンドポイントの名前です。名前の長さは 1～128 文字である必要があります。	test
ServiceName	string	任意	エンドポイントサービスの名前です。	com.aliyun.cn-hangzhou.oss
NextToken	string	任意	次のリクエストで新しいページの結果を取得するために使用するページネーショントークンです。有効値は以下のとおりです。最初のリクエストでは、このパラメーターを指定する必要はありません。 NextToken の値が返された場合、その値を次のリクエストに指定して、新しいページの結果を取得します。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	任意	1 ページあたりに返されるエントリー数です。有効値：1～100。デフォルト値：20。	20
RegionId	string	必須	ゲートウェイエンドポイントのリージョン ID です。最新のリージョンリストをクエリするには、DescribeRegions 操作を呼び出します。	cn-hangzhou
ResourceGroupId	string	任意	ゲートウェイエンドポイントが属するリソースグループの ID です。	rg-acfmxvfvazb4p****
Tags	array<object>	任意	タグリストです。
	object	任意	タグリストです。
Key	string	任意	リソースに追加されたタグ N のキーです。最大 20 個のタグキーを指定できます。空文字列にすることはできません。キーの長さは 64 文字以内で、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。キーは英字で始まる必要がありますが、`aliyun` または `acs:` で始めることはできません。また、`http://` または `https://` を含めることはできません。	FinanceDept
Value	string	任意	リソースに追加されたタグ N の値です。最大 20 個のタグ値を指定できます。タグ値は空文字列にすることも可能です。タグ値の長さは 128 文字以内で、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。値は英字で始まる必要がありますが、`aliyun` または `acs:` で始めることはできません。また、`http://` または `https://` を含めることはできません。	FinanceJoshua
VpcId	string	任意	ゲートウェイエンドポイントが属する仮想プライベートクラウド (VPC) の ID です。	vpc-bp1gsk7h12ew7oegk****

レスポンスフィールド

フィールド	型	説明	例
	object	リクエスト ID です。
RequestId	string	リクエスト ID です。	0AB1129F-32C1-5E4D-9E22-E4A859CA46EB
NextToken	string	ページネーショントークンです。次のリクエストで新しいページの結果を取得するために使用できます。有効値は以下のとおりです。 NextToken の値が返されない場合、次のクエリは送信されません。 NextToken の値が返された場合、その値を次のリクエストに使用して、新しいページの結果を取得できます。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	返されたエントリー数です。	10
Endpoints	array<object>	ゲートウェイエンドポイントのリストです。
	array<object>
EndpointId	string	ゲートウェイエンドポイントの ID です。	vpce-bp1i1212ss2whuwyw****
EndpointName	string	ゲートウェイエンドポイントの名前です。	test
EndpointDescription	string	ゲートウェイエンドポイントの説明です。	test_description
ServiceName	string	エンドポイントサービスの名前です。	com.aliyun.cn-hangzhou.oss
VpcId	string	ゲートウェイエンドポイントが属する仮想プライベートクラウド (VPC) の ID です。	vpc-bp1gsk7h12ew7oegk****
PolicyDocument	string	クラウドサービスのアクセスポリシーです。アクセスポリシーの構文および構造の詳細については、「ポリシーの構文と構造」をご参照ください。	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
CreationTime	string	エンドポイントの作成時刻です。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式に従い、協定世界時 (UTC) で表示されます。	2021-09-08T08:43:04Z
EndpointStatus	string	ゲートウェイエンドポイントのステータスです。有効値： Creating Created Modifying Associating Dissociating Deleting	Created
AssociatedRouteTables	array	ゲートウェイエンドポイントに関連付けられたルートテーブルの ID です。
	string	ゲートウェイエンドポイントに関連付けられたルートテーブルの ID です。	vtb-bp1sme72jnuodvyx7****
ResourceGroupId	string	ゲートウェイエンドポイントが属するリソースグループの ID です。	rg-acfmxvfvazb4p****
Tags	array<object>	タグリストです。
	object
Key	string	リソースに追加されたタグ N のキーです。	FinanceDept
Value	string	リソースに追加されたタグ N の値です。	FinanceJoshua
MaxResults	integer	1 ページあたりのエントリー数です。	20

例

成功レスポンス

JSONJSON

{
  "RequestId": "0AB1129F-32C1-5E4D-9E22-E4A859CA46EB",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 10,
  "Endpoints": [
    {
      "EndpointId": "vpce-bp1i1212ss2whuwyw****",
      "EndpointName": "test",
      "EndpointDescription": "test_description",
      "ServiceName": "com.aliyun.cn-hangzhou.oss",
      "VpcId": "vpc-bp1gsk7h12ew7oegk****",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "CreationTime": "2021-09-08T08:43:04Z",
      "EndpointStatus": "Created",
      "AssociatedRouteTables": [
        "vtb-bp1sme72jnuodvyx7****"
      ],
      "ResourceGroupId": "rg-acfmxvfvazb4p****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ],
  "MaxResults": 20
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalParam.NextToken	The specified NextToken is invalid.
400	IllegalParam.MaxResults	The param of MaxResults is illegal.
400	InvalidVpcId.NotFound	Specified value of VpcId is not found in our record.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。