registerAssetUpload
Asset upload を登録する
POST/v1.0/content-spaces/{contentSpaceId}/asset-uploads
Schema preview / 現在は一般提供されていません
1 operationはOpenAPIでschema-onlyとして公開されています。このReferenceからAPI requestは送信できません。
媒体本体は request body に含めず、後続の presigned URL へ直接送信する。
Authentication
すべてのrequestはX-Api-Key headerを使用します。schema-onlyのため、このページにcredential入力やlive requestはありません。
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| contentSpaceIdrequired | path | string | content_space_id は Asset を登録する `space_` + ULID 形式の ContentSpace ID である。 |
| X-Request-Id | header | string | 要求相関 ID。省略時は Gateway が生成する。 |
| Idempotency-Keyrequired | header | string | 同一主体、version、endpoint、security workspace 内で登録を収束させる key。visible ASCII、最大255 byte。 |
Request body
PublicLifecycleServiceRegisterAssetUploadBody
PublicRegisterAssetUploadRequest は direct upload 前に媒体 metadata を登録する。
| Field | Type | Description |
|---|---|---|
| displayNamerequired | string | display_name は1文字以上200文字以下の利用者向け表示名である。 |
| mediaTyperequired | v1PublicMediaType | media_type は登録する媒体種別である。 |
| digestrequired | string | digest は登録内容の `sha256:` + hex 形式の digest である。 |
| sizeBytesrequired | string | size_bytes は登録内容の byte 単位の正のサイズである。 |
| contentType | string | content_type は媒体本体の MIME type であり、署名対象 header と一致させる。 |
Responses and errors
201Asset upload resource を作成した。
v1PublicLifecycleServiceRegisterAssetUploadResponse
PublicRegisterAssetUploadResponse は作成した upload 登録を返す。
| Field | Type | Description |
|---|---|---|
| assetUpload | v1PublicAssetUpload | asset_upload は presign と confirm に使用する公開 upload resource である。 |
| presignedUpload | v1PublicPresignedUpload | presigned_upload は媒体本体を Gateway を経由せず直接送る URL と署名条件を含む。 |
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 超過による拒否時だけ設定する機械可読な詳細である。 |
404ContentSpace が存在しない、または security workspace から参照できない。
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 超過による拒否時だけ設定する機械可読な詳細である。 |