すべてのプロダクト
Search

このプロダクト

    Smart Access Gateway:AddSmartAccessGatewayDnsForward

    ドキュメントセンター

    Smart Access Gateway:AddSmartAccessGatewayDnsForward

    最終更新日:Dec 21, 2025

    SCG5000 または SCG5000-5G インスタンスに DNS 転送設定を追加します。デバイスバージョンは 3.4.2 以降である必要があります。

    今すぐお試しください

    この 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:AddSmartAccessGatewayDnsForward

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SagInsId

    string

    必須

    インスタンスの ID。

    sag-v9un1ccz22owd76lf8
    SagSn

    string

    必須

    デバイスのシリアル番号 (SN)。

    sagf4dkqh78
    Domain

    string

    必須

    ドメイン名。

    説明

    • ワイルドカードドメイン名をサポートしています。ワイルドカード文字のアスタリスク (*) を使用して、ワイルドカードドメイン名を指定できます。

    たとえば、*.baidu.com と入力してドメイン名 baidu.com を指定できます。

    www.aliyun.com
    MasterIp

    string

    必須

    プライマリ DNS サーバ。

    114.114.114.114
    SlaveIp

    string

    任意

    セカンダリ DNS サーバ。

    172.16.0.14
    Mode

    string

    任意

    転送モード。

    説明

    • このパラメーターは使用されていません。このパラメーターは無視してください。

    first
    OutboundPortType

    string

    任意

    送信ポートのタイプ。

    説明

    • 値が `Tunnel` の場合はトンネルを、`PhysicalPort` の場合は物理ポートを指定します。

    列挙値:

    • Tunnel :

      Tunnel

    • PhysicalPort :

      PhysicalPort

    • None :

      None

    Tunnel
    OutboundPortIndex

    string

    任意

    送信ポートの番号。

    説明

    • このパラメーターは、`OutboundPortType` が `PhysicalPort` に設定されている場合はオプションです。`OutboundPortType` が `Tunnel` に設定されている場合は、このパラメーターを無視してください。

    • `OutboundPortIndex` の値は、`poOutboundPortName` で指定されたポート名の一意なインデックスです。たとえば、`0` は `eth0` という名前のポートのインデックスで、`2` は `lte` という名前のポートのインデックスです。

    列挙値:

    • 0 :

      0

    • 2 :

      2

    0
    OutboundPortName

    string

    任意

    送信ポート。

    説明

    • このパラメーターは、`OutboundPortType` が `PhysicalPort` に設定されている場合はオプションです。`OutboundPortType` が `Tunnel` に設定されている場合は、このパラメーターを無視してください。

    • `OutboundPortIndex` の値は、`poOutboundPortName` で指定されたポート名の一意なインデックスです。たとえば、`0` は `eth0` という名前のポートのインデックスで、`2` は `lte` という名前のポートのインデックスです。

    列挙値:

    • eth0 :

      eth0

    • lte :

      lte

    eth0
    RegionId

    string

    必須

    インスタンスがデプロイされているリージョンの ID。

    cn-shanghai

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    RequestId

    string

    リクエストの ID

    E93884AC-6C21-4FEA-8E3A-7377D33B194F
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    Code

    string

    エラーコード。値が 200 の場合は、呼び出しが成功したことを示します。

    200
    Message

    string

    応答メッセージ。

    Successful
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Data

    object

    リクエストに対して返される情報。

    InstanceId

    string

    インスタンスの ID。

    sagv3dnsforward-nc7qabskj17werc7su
    Domain

    string

    ドメイン名。

    yfiy.cn
    MasterIp

    string

    プライマリ DNS サーバ。

    14.104.81.13
    SlaveIp

    string

    セカンダリ DNS サーバ。

    172.16.0.14
    Mode

    string

    転送モード。

    first
    OutboundPortType

    string

    送信ポートのタイプ。

    PhysicalPort
    OutboundPortIndex

    integer

    送信ポートの番号。

    0
    OutboundPortName

    string

    送信ポート。

    eth0

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "E93884AC-6C21-4FEA-8E3A-7377D33B194F",
  "Success": true,
  "Code": "200",
  "Message": "Successful",
  "HttpStatusCode": 200,
  "Data": {
    "InstanceId": "sagv3dnsforward-nc7qabskj17werc7su",
    "Domain": "yfiy.cn",
    "MasterIp": "14.104.81.13",
    "SlaveIp": "172.16.0.14",
    "Mode": "first",
    "OutboundPortType": "PhysicalPort",
    "OutboundPortIndex": 0,
    "OutboundPortName": "eth0"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidSpec.FeatureNotSupport The current edition of the cloudbranch does not support this feature.
    400 GATEWAY.InvalidSN The specified gateway serial number does not exist.
    400 CCN.DuplicateDNSForwardingDomain Duplicate DNS forwarding domain
    400 ConfigUnsynchronized The configs of device are unsynchronized,please check whether the device is online
    400 DeviceNotExist The specified device does not exist
    400 FeatureNotSupport The current edition of the smart access gateway does not support this feature.
    400 CCN.DNS.Forward.CreateFailed failed to create dns forward config
    404 ResourceNotFound.Device The specified resource of Device is not found.

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

    変更履歴

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