DescribeDnatEntries API の呼び出し - SAG

Smart Access Gateway (SAG) インスタンスに関連付けられている DNAT エントリを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

smartag:DescribeDnatEntries

get

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	SAG インスタンスが配置されているリージョン ID。	cn-hangzhou
SagId	string	必須	SAG インスタンスの ID。説明 SAG CPE (Customer-Premises Equipment) インスタンスのみがサポートされます。	sag-djgd*************
Type	string	任意	DNAT エントリのタイプ。有効な値： Intranet：IP アドレスを特定のプライベート IP アドレスに変換します。これはデフォルト値です。 Internet：IP アドレスを特定のパブリック IP アドレスに変換します。	Intranet
PageSize	integer	任意	各ページに返すエントリ数。デフォルト値：10。最大値：50。	12
PageNumber	integer	任意	返すページの番号。デフォルト値：1。	1

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたエントリの総数。	50
PageSize	integer	各ページに返されるエントリ数。デフォルト値：10。最大値：50。	1
RequestId	string	リクエスト ID。	635640CA-2335-4856-A9CB-1CB5C444DC5A
PageNumber	integer	返されたページのページ番号。デフォルト値：1。	12
DnatEntries	object
DnatEntry	array<object>	DNAT エントリのリスト。
	object
Type	string	DNAT エントリのタイプ。有効な値： Intranet：IP アドレスが特定のプライベート IP アドレスに変換されました。これはデフォルト値です。 Internet：IP アドレスが特定のパブリック IP アドレスに変換されました。	Intranet
SagId	string	SAG インスタンスの ID。	sag-jfh********
InternalIp	string	宛先プライベート IP アドレス。	192.168.0.1
InternalPort	string	宛先プライベートポート。有効な値：1～65535 および any。「any」はすべてのポートを示します。	80
IpProtocol	string	DNAT で使用されるプロトコル。有効な値： tcp。 udp。 any：すべてのプロトコル。	tcp
ExternalPort	string	パブリックポート。有効な値：1～65535 および any。「any」はすべてのポートを示します。	12
DnatEntryId	string	DNAT エントリの ID。	fwd-kxe4fq3xuzczze****
ExternalIp	string	パブリック IP アドレス。	10.10..

例

成功レスポンス

JSONJSON

{
  "TotalCount": 50,
  "PageSize": 1,
  "RequestId": "635640CA-2335-4856-A9CB-1CB5C444DC5A",
  "PageNumber": 12,
  "DnatEntries": {
    "DnatEntry": [
      {
        "Type": "Intranet",
        "SagId": "sag-jfh********",
        "InternalIp": "192.168.0.1",
        "InternalPort": "80",
        "IpProtocol": "tcp",
        "ExternalPort": "12",
        "DnatEntryId": "fwd-kxe4fq3xuzczze****",
        "ExternalIp": "10.10.**.**"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
403	Forbidden	User not authorized to operate on the specified resource.
403	MissingParameter	The input parameter is missing, please check your input.
403	InvalidParameter	The specified parameter is invalid.
403	InternalError	An internal server error occurred.

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

変更履歴

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