すべてのプロダクト
Search
ドキュメントセンター

Identity as a Service:ListNetworkAccessEndpoints

最終更新日:Sep 03, 2026

IDaaS EIAM インスタンス配下のネットワークアクセスエンドポイントのリストを照会します。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eiam:ListNetworkAccessEndpoints

get

*NetworkAccessEndpoint

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

InstanceId

string

必須

インスタンスの ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

NextToken

string

任意

ページネーショントークン。このパラメーターには、前の API 呼び出しで返された NextToken の値を設定します。最初のクエリでは、このパラメーターを空にします。

NTxxxxxexample

MaxResults

integer

任意

ページングクエリにおける 1 ページあたりの行数。最大値: 100。

20

NetworkAccessEndpointType

string

任意

ネットワークアクセスエンドポイントのタイプ。有効な値:

  • shared: 共有ネットワークアクセスエンドポイント。

  • private: 非公開ネットワークアクセスエンドポイント。

デフォルト値: private。

private

VpcId

string

任意

専用ネットワークアクセスエンドポイントの VPC ID。NetworkAccessEndpointType が shared に設定されている場合、このパラメーターは効果がありません。

vpc-examplexxx

VpcRegionId

string

任意

専用ネットワークアクセスエンドポイントの VPC のリージョン。リージョンは、ListNetworkAccessEndpointAvailableRegions 操作によって返されるリージョンのいずれかである必要があります。NetworkAccessEndpointType が shared に設定されている場合、このパラメーターは効果がありません。

cn-hangzhou

NetworkAccessEndpointStatus

string

任意

ネットワークアクセスエンドポイントのステータス。有効な値:

  • pending: 初期化待ち。

  • creating: 作成中。

  • running: 実行中。

  • deleting: 削除中。

NetworkAccessEndpointType が shared に設定されている場合、このフィルターパラメーターは効果がありません。

running

レスポンスフィールド

フィールド

型

説明

例

object

RequestId

string

リクエストの ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

TotalCount

integer

リスト内のエントリの総数。

100

NextToken

string

この呼び出しによって返されるページネーショントークン。

NTxxxexample

NetworkAccessEndpoints

array<object>

ネットワークアクセスエンドポイントのリスト。

array<object>

ネットワークアクセスエンドポイントの情報。

InstanceId

string

インスタンスの ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

NetworkAccessEndpointId

string

ネットワークアクセスエンドポイントの ID。

nae_examplexxx

NetworkAccessEndpointName

string

ネットワークアクセスエンドポイントの名前。たとえば、特定の業務用の VPC アクセスエンドポイントなどです。

xx サービス用 VPC アクセスエンドポイント

VpcId

string

専用ネットワークアクセスエンドポイントの VPC ID。

vpc-examplexxx

VpcRegionId

string

専用ネットワークアクセスエンドポイントの VPC のリージョン。

cn-hangzhou

VSwitchIds

array

専用ネットワークアクセスエンドポイントの vSwitch のリスト。

vsw-examplexxx

string

vSwitch の ID。

vsw-2vc8z0f90z4k6xxxxx

SecurityGroupId

string

専用ネットワークアクセスエンドポイントで使用されるセキュリティグループの ID。

sg-examplexxx

Status

string

ネットワークアクセスエンドポイントのステータス。有効な値:

  • pending: 初期化待ち。

  • creating: 作成中。

  • running: 実行中。

  • deleting: 削除中。

running

NetworkAccessEndpointType

string

ネットワークアクセスエンドポイントのタイプ。有効な値:

  • shared: 共有ネットワークアクセスエンドポイント。

  • private: 非公開ネットワークアクセスエンドポイント。

private

CreateTime

integer

ネットワークアクセスエンドポイントの作成時間。値はミリ秒単位の UNIX タイムスタンプです。

1649830226000

UpdateTime

integer

ネットワークアクセスエンドポイントの最終更新時間。値はミリ秒単位の UNIX タイムスタンプです。

1649830226000

BackupVpcEndpoint

object

バックアップネットワークアクセスエンドポイントの VPC 構成。

BackupVpcRegionId

string

バックアップネットワークアクセスエンドポイントの VPC のリージョン。

cn-beijing

BackupVpcId

string

バックアップネットワークアクセスエンドポイントの VPC ID。

vpc-examplexxx

BackupVSwitchIds

array

バックアップネットワークアクセスエンドポイントの vSwitch のリスト。

string

バックアップネットワークアクセスエンドポイントの vSwitch ID。

vsw-wz94gvcxxxxx

BackupSecurityGroupId

string

バックアップネットワークアクセスエンドポイントのセキュリティグループ ID。

sg-examplexxx

BackupEgressPublicIpAddresses

array

バックアップネットワークアクセスエンドポイントのパブリック送信元 IP アドレスのリスト。

string

バックアップネットワークアクセスエンドポイントのパブリック送信元 IP アドレス。

重要 値は返されません。VPC コンソールで NAT Gateway の IP アドレスを照会してください。

""

BackupEgressPrivateIpAddresses

array

バックアップネットワークアクセスエンドポイントのプライベート送信元 IP アドレスのリスト。

string

バックアップネットワークアクセスエンドポイントのプライベート送信元 IP アドレス。

172.16.x.x

例

成功レスポンス

JSONJSON

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample。",
  "NetworkAccessEndpoints": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx。",
      "NetworkAccessEndpointId": "nae_examplexxx。",
      "NetworkAccessEndpointName": "xx サービス用の VPC アクセスエンドポイント。",
      "VpcId": "vpc-examplexxx。",
      "VpcRegionId": "cn-hangzhou。",
      "VSwitchIds": [
        "vsw-2vc8z0f90z4k6xxxxx。"
      ],
      "SecurityGroupId": "sg-examplexxx。",
      "Status": "running",
      "NetworkAccessEndpointType": "private",
      "CreateTime": 1649830226000,
      "UpdateTime": 1649830226000,
      "BackupVpcEndpoint": {
        "BackupVpcRegionId": "cn-beijing",
        "BackupVpcId": "vpc-examplexxx",
        "BackupVSwitchIds": [
          "vsw-wz94gvcxxxxx"
        ],
        "BackupSecurityGroupId": "sg-examplexxx",
        "BackupEgressPublicIpAddresses": [
          "\"\""
        ],
        "BackupEgressPrivateIpAddresses": [
          "172.16.x.x"
        ]
      }
    }
  ]
}

エラーコード

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

変更履歴

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