REST Resource: projects.locations.saas

リソース: Saas

Saas は、プロデューサーが管理する SaaS サービスを表します。

JSON 表現
{
  "name": string,
  "locations": [
    {
      object (Location)
    }
  ],
  "state": enum (State),
  "conditions": [
    {
      object (SaasCondition)
    }
  ],
  "error": {
    object (Status)
  },
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string
}
フィールド
name

string

ID。標準の命名スキームに沿ったリソース名(リソースの完全な URI)。

"projects/{project}/locations/{location}/saas/{saas}"

locations[]

object (Location)

省略可。サービスが利用可能なロケーションのリスト。ロールアウトは、ロールアウト プランを生成するリストを参照します。

state

enum (State)

出力専用。SaaS の状態。applicationTemplate が空の場合、常に ACTIVE 状態になります。

conditions[]

object (SaasCondition)

出力専用。このリソースが持つ可能性のあるさまざまな条件を示す一連の条件。

error

object (Status)

出力専用。状態が FAILED の場合、対応するエラーコードとメッセージ。その他のすべての状態では、デフォルトで code=OK になります。

labels

map (key: string, value: string)

省略可。リソースのラベル。分類に使用できます。Kubernetes リソースラベルに似ています。

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

annotations

map (key: string, value: string)

省略可。アノテーションは、任意のメタデータを保存して取得するため、外部ツールによって設定される可能性のあるリソースとともに保存される非構造化 Key-Value マップです。クエリは実行可能ではなく、オブジェクトを変更する際に保持する必要があります。

詳細: https://kubernetes.io/docs/user-guide/annotations

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

uid

string

出力専用。リソースの一意の識別子。UID は、サービスのスコープ内で、このリソースの時間と場所において一意性を持ちます。通常は、リソースの作成時にサーバーによって生成され、変更されることはありません。UID は、リソース名が再利用される場合でも一意にリソースを識別するために使用されます。UUID4 であることが必要です。

etag

string

出力専用。リソースのバージョンまたは世代を一意に識別する、不透明な値です。書き込まれるリソースの順序についてクライアントとサーバーの間で確実に同意するために使用できます。

createTime

string (Timestamp format)

出力専用。リソース作成時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

出力専用。リソース最終更新時のタイムスタンプ。ユーザーがリソースを変更した場合は、この値を更新する必要があります。サービスがリソースを変更した場合は、この値を更新する必要があります。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

場所

サービスが利用可能なロケーション情報。

JSON 表現
{
  "name": string
}
フィールド
name

string

省略可。場所の名前。

状態

SaaS の状態。

列挙型
STATE_TYPE_UNSPECIFIED 状態タイプが指定されていません。
ACTIVE

非推奨: STATE_ACTIVE を使用してください。

RUNNING

非推奨: STATE_RUNNING を使用してください。

FAILED

非推奨: STATE_FAILED を使用してください。

STATE_ACTIVE SaaS の準備が完了しました
STATE_RUNNING ApplicationTemplate のインポート、同期、レプリケーションのプロセス中
STATE_FAILED ApplicationTemplate のインポート、同期、複製処理中の障害

SaasCondition

SaasCondition は、Saas のステータスを表します。

JSON 表現
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
フィールド
status

enum (Status)

必須。条件のステータス。

type

enum (Type)

必須。条件のタイプ。

lastTransitionTime

string (Timestamp format)

必須。ある状態から別の状態に遷移した最後の時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

message

string

必須。最後の移行の詳細を示す人間が読めるメッセージ。

reason

string

必須。条件の最後の遷移の簡単な理由。

ステータス

条件ステータスの列挙。

列挙型
STATUS_UNSPECIFIED 条件のステータスが指定されていません。
STATUS_UNKNOWN 条件が不明です。
STATUS_TRUE 条件が true の場合。
STATUS_FALSE 条件が false です。

タイプ

条件タイプの列挙。

列挙型
TYPE_UNSPECIFIED 条件タイプが指定されていません。
TYPE_READY 条件タイプが準備完了。
TYPE_SYNCHRONIZED 条件タイプが同期されます。

メソッド

create

新しい saas を作成します。

delete

1 つの saas を削除します。

get

単一の saas を取得します。

list

saas のコレクションを取得します。

patch

単一の SaaS を更新します。