createContentSpace
ContentSpace を作成する
POST/v1.0/content-spaces
Schema preview / 現在は一般提供されていません
1 operationはOpenAPIでschema-onlyとして公開されています。このReferenceからAPI requestは送信できません。
Authentication
すべてのrequestはX-Api-Key headerを使用します。schema-onlyのため、このページにcredential入力やlive requestはありません。
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| X-Request-Id | header | string | 要求相関 ID。省略時は Gateway が生成する。 |
| Idempotency-Keyrequired | header | string | 同一主体、version、endpoint、security workspace 内で作成を収束させる key。visible ASCII、最大255 byte。 |
Request body
v1PublicLifecycleServiceCreateContentSpaceRequest
PublicCreateContentSpaceRequest は ContentSpace の公開作成要求である。
| Field | Type | Description |
|---|---|---|
| displayNamerequired | string | display_name は1文字以上200文字以下の利用者向け表示名である。 |
Responses and errors
201ContentSpace を作成した。
v1PublicLifecycleServiceCreateContentSpaceResponse
PublicCreateContentSpaceResponse は作成済み ContentSpace を返す。
| Field | Type | Description |
|---|---|---|
| contentSpace | v1PublicContentSpace | content_space は workspace 参照を除いた公開 projection である。 |
400公開 request の形式、必須項目、または範囲が不正である。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |
401API key を検証できない。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |
429rate limit または quota を超過した。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |
500予期しない内部失敗が発生した。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |
503credential provider が一時的に利用できない。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |