REST リソース: projects.locations.instances

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

リソース: インスタンス

Google Cloud Redis のインスタンス。

JSON 表現

{
  "name": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "locationId": string,
  "alternativeLocationId": string,
  "redisVersion": string,
  "reservedIpRange": string,
  "host": string,
  "port": number,
  "currentLocationId": string,
  "createTime": string,
  "state": enum(State),
  "statusMessage": string,
  "redisConfigs": {
    string: string,
    ...
  },
  "tier": enum(Tier),
  "memorySizeGb": number,
  "authorizedNetwork": string
}
フィールド
name

string

必須。プロジェクトとロケーションを含むスコープ内で一意のリソース名。projects/{projectId}/locations/{locationId}/instances/{instanceId} という形式を使用します。

注: Redis インスタンスはリージョン レベルで管理され、アドレス指定されるため、locationId の部分は GCP のリージョンを指します。ただし、インスタンスをプロビジョニングするゾーン(複数のゾーンにまたがるインスタンスの場合はゾーンのコレクション)はユーザーが選択できます。詳細については、[locationId] と [alternativeLocationId] フィールドを参照してください。

displayName

string

ユーザーが指定する任意で省略可能なインスタンスの名前。

labels

map (key: string, value: string)

ユーザーが指定したメタデータを表すリソースラベル

"key": value ペアのリストが含まれるオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

locationId

string

省略可。インスタンスがプロビジョニングされるゾーン。指定しない場合は、サービスによってインスタンスのゾーンが選択されます。STANDARD_HA 階層の場合、ゾーン障害に対する保護を目的として、インスタンスが 2 つのゾーンにまたがって作成されます。[alternativeLocationId] も指定する場合は、[locationId] と異なるものにする必要があります。

alternativeLocationId

string

省略可。STANDARD_HA 階層だけに該当します。2 つのゾーンにまたがってプロビジョニングすることで、ゾーン障害に対する保護を提供します。指定する場合は、[locationId] で指定されているゾーンとは異なるゾーンにする必要があります。

redisVersion

string

省略可。Redis ソフトウェアのバージョン。指定しない場合は、サポートされている最新のバージョンが使用されます。バージョンを更新すると、新しいバージョンへのアップグレード / ダウングレードが実行されます。現在サポートされている値は REDIS_3_2 で、Redis 3.2 を表します。

reservedIpRange

string

省略可。このインスタンス用に予約されている内部アドレスの CIDR 範囲。指定しない場合は、10.0.0.0/29 や 192.168.0.0/29 など、未使用の /29 ブロックがサービスによって選択されます。範囲は一意でなければならず、承認済みネットワーク内の既存のサブネットと重複していてはなりません。

host

string

出力のみ。クライアントがサービスに接続するために使用する、公開されている Redis エンドポイントのホスト名または IP アドレス。

port

number

出力のみ。公開されている Redis エンドポイントのポート番号。

currentLocationId

string

出力のみ。Redis エンドポイントが配置されている現在のゾーン。基本階層のインスタンスの場合は、作成時にユーザーが指定した [locationId] と常に同じになります。標準階層のインスタンスの場合は [locationId] または [alternativeLocationId] のいずれかとなり、フェイルオーバーの発生後に変化する場合があります。

createTime

string (Timestamp 形式)

出力のみ。インスタンスが作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。例: "2014-10-02T15:01:23.045123456Z"

state

enum(State)

出力のみ。このインスタンスの現在の状態。

statusMessage

string

出力のみ。このインスタンスの現在のステータスに関する追加情報(利用可能な場合)。

redisConfigs

map (key: string, value: string)

省略可。http://redis.io/topics/config に従った Redis 構成パラメータ。現在サポートされているパラメータは次のものだけです。

  • maxmemory-policy
  • notify-keyspace-events

"key": value ペアのリストが含まれるオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

tier

enum(Tier)

必須。インスタンスのサービス階層。

memorySizeGb

number

必須。Redis のメモリサイズ(GiB 単位)。

authorizedNetwork

string

省略可。インスタンスが接続されている Google Compute Engine ネットワークの完全修飾名。指定しない場合、default ネットワークが使用されます。

状態

Redis インスタンスのさまざまな状態を表します。

列挙型
STATE_UNSPECIFIED 未設定。
CREATING Redis インスタンスを作成中です。
READY Redis インスタンスが作成済みで、完全に使用可能です。
UPDATING Redis インスタンスの構成を更新中です。更新の種類によっては、更新の進行中にインスタンスが使用不能になることがあります。
DELETING Redis インスタンスを削除中です。
REPAIRING Redis インスタンスを修復中のため、使用できない可能性があります。詳細については、statusMessage フィールドをご覧ください。
MAINTENANCE この Redis インスタンスに対するメンテナンスが実行中です。

階層

選択可能な提供中のサービス階層

列挙型
TIER_UNSPECIFIED 未設定。
BASIC BASIC 階層: スタンドアロン インスタンス
STANDARD_HA STANDARD_HA 階層: 高可用性のプライマリ / レプリカ インスタンス

メソッド

create

指定した階層とメモリサイズに基づいて Redis インスタンスを作成します。

delete

特定の Redis インスタンスを削除します。

get

特定の Redis インスタンスの詳細を取得します。

list

指定したロケーション(リージョン)またはすべてのロケーションのいずれかのプロジェクトによって所有されているすべての Redis インスタンスをリストします。

patch

特定の Redis インスタンスのメタデータと構成を更新します。