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

PolarDB:DescribeGatewayAttribute

最終更新日:May 08, 2026

ゲートウェイインスタンスの詳細の表示

今すぐお試しください

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

テスト

RAM 認証

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

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

GwClusterId

string

必須

ゲートウェイインスタンスの ID です。

pg-xxxxxxx

RegionId

string

任意

リージョンの ID です。

cn-beijing

レスポンスフィールド

フィールド

型

説明

例

object

応答のスキーマです。

RequestId

string

リクエストの ID です。

3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF

VpcId

string

ゲートウェイインスタンスがデプロイされている VPC の ID です。

vpc-*************

VSwitchId

string

ゲートウェイインスタンスがデプロイされている VSwitch の ID です。

vsw-*********************

PayType

string

ゲートウェイインスタンスの課金方法です。有効な値は次のとおりです。

  • Postpaid:従量課金

  • Prepaid:サブスクリプション

Postpaid

GwClusterId

string

ゲートウェイインスタンスの ID です。

pg-xxxxxxx

GwDescription

string

ゲートウェイインスタンスの説明です。

xxx

Status

string

ゲートウェイインスタンスのステータスです。有効な値は次のとおりです。

  • CREATE:ゲートウェイインスタンスを作成中です。

  • ACTIVATION:ゲートウェイインスタンスは実行中です。

ACTIVATION

RegionId

string

リージョンの ID です。

cn-beijing

DbType

string

データベースタイプです。

MySQL

CreateTime

string

ゲートウェイインスタンスの作成時刻です。

2020-02-24T11:57:54Z

ModifyTime

string

ゲートウェイインスタンスの最終変更時刻です。

2025-10-07T02:19:55Z

ClassCode

string

ゲートウェイインスタンスの仕様コードです。

polar.app.g2.medium

ExpireTime

string

ゲートウェイインスタンスのサブスクリプションの有効期限です。

このパラメーターは、従量課金インスタンスでは空になります。

2027-04-22T16:00:00Z

Endpoints

array<object>

ゲートウェイインスタンスのエンドポイントリストです。

object

エンドポイントの詳細を含みます。

Address

string

エンドポイントアドレスです。

pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com

EndpointId

string

エンドポイントの ID です。

xxx

GwClusterId

string

ゲートウェイインスタンスの ID です。

pg-xxxxxxx

Port

string

ポート番号です。

8080

TunnelId

string

トンネル ID です。

1874631

VpcId

string

エンドポイントが属する VPC の ID です。

vpc-*************

NetType

string

エンドポイントのネットワークタイプです。有効な値は次のとおりです。

  • Private:VPC エンドポイント

  • Public:パブリックエンドポイント

Public

Expired

boolean

ゲートウェイインスタンスのサブスクリプションが期限切れかどうかを示します。有効な値は次のとおりです。

  • true

  • false

False

SecurityIPArrays

array<object>

ゲートウェイインスタンスの IP ホワイトリストのリストです。

object

IP ホワイトリストの詳細を含みます。

SecurityIPArrayTag

string

IP ホワイトリストのタグです。

mytag

SecurityIPList

string

IP ホワイトリスト内の IP アドレスをカンマ区切りで記述したリストです。

127.0.0.1

SecurityIPArrayName

string

IP ホワイトリストの名前です。デフォルト値は default です。

default

LatestVersion

string

CurrentVersion

string

RunningVersion

string

例

成功レスポンス

JSONJSON

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "VpcId": "vpc-*************",
  "VSwitchId": "vsw-*********************",
  "PayType": "Postpaid",
  "GwClusterId": "pg-xxxxxxx",
  "GwDescription": "xxx",
  "Status": "ACTIVATION",
  "RegionId": "cn-beijing",
  "DbType": "MySQL",
  "CreateTime": "2020-02-24T11:57:54Z",
  "ModifyTime": "2025-10-07T02:19:55Z",
  "ClassCode": "polar.app.g2.medium",
  "ExpireTime": "2027-04-22T16:00:00Z",
  "Endpoints": [
    {
      "Address": "pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com",
      "EndpointId": "xxx",
      "GwClusterId": "pg-xxxxxxx",
      "Port": "8080",
      "TunnelId": "1874631",
      "VpcId": "vpc-*************",
      "NetType": "Public"
    }
  ],
  "Expired": true,
  "SecurityIPArrays": [
    {
      "SecurityIPArrayTag": "mytag",
      "SecurityIPList": "127.0.0.1",
      "SecurityIPArrayName": "default"
    }
  ],
  "LatestVersion": "",
  "CurrentVersion": "",
  "RunningVersion": ""
}

エラーコード

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

変更履歴

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