プロジェクトの更新 (PATCH /v3/projects/{project_id})
指定されたプロジェクトを更新する。
プロジェクトを使用しなくなった場合、有効設定を無効(false)で更新する。
ただし、デフォルトプロジェクトは無効化することができない。
プロジェクトの無効化を行う前に、プロジェクト配下のリソースを停止または削除しておく必要がある。(リソースを停止しないと課金がされたままとなる)
無効となったプロジェクトは、そのプロジェクトに対する認証(ロール取得を含む)ができなくなる。 また、無効化されたプロジェクトのトークンを使用していた場合、そのトークンは無効となる。
Request Headers
Content-type
MIME仕様で定義されているコンテントの形式を示す。
application/jsonを指定する。(必須項目)
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Accept
MIME仕様で定義されているアクセプトの形式を示す。
application/jsonを指定する。(省略可)
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
X-Auth-Token
有効な認証トークン
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Request Parameter
project_id
プロジェクトID(必須項目)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | なし | None |
project
projectオブジェクト
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1.1 | なし | description
enabled name |
description
プロジェクトの説明
入力値は、「プロジェクトの追加 (POST /v3/projects)」を参照
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 0..1 | project | None |
enabled
有効設定
入力値は、「プロジェクトの追加 (POST /v3/projects)」を参照
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:boolean | 0..1 | project | None |
name
プロジェクト名
入力値は、「プロジェクトの追加 (POST /v3/projects)」を参照
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 0..1 | project | None |
Response Headers
HTTPステータスコード
リクエストのHTTPステータスコードを返却する。
以下の値を返却する。
- 200:
- 正常終了
- 400:
- 不正なアクセス(パラメーター不正等)
- 401:
- 認証エラー
- 403:
- アクセス不可(権限がない)
- 404:
- 該当資源なし
- 409:
- データ競合が発生
- 500:
- 予期せぬエラー
- 501:
- 実装されていない
- 503:
- サービス利用不可
Data Type | Cardinality |
---|---|
int | 1..1 |
Vary
以下のヘッダーを設定または変更することで、別のファイル形式で表現を要求できることを通知する。
X-Auth-Token
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Content-Type
MIME仕様で定義されているコンテントの形式を示す。
application/json
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Content-Length
エンティティの長さをバイトで示す。
Data Type | Cardinality |
---|---|
int | 1..1 |
Date
作成された日付を示す。
Data Type | Cardinality |
---|---|
date | 1..1 |
Response Elements
project
projectオブジェクト
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..1 | なし | description domain_id enabled extra id links name |
description
プロジェクトの説明
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | project | None |
domain_id
ドメインID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | project | None |
enabled
有効設定
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:boolean | 1..1 | project | None |
extra
拡張情報
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | project | None |
id
プロジェクトID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | project | None |
links
プロジェクトのリンク情報
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..1 | project | self |
name
プロジェクト名
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | project | None |
Example of Request
PATCH /v3/projects/--project-id--
X-Auth-Token: MIIIHgYJKoZIhvcNAQcCoIIIDzCCCAsCAQExC(省略)
{
"project": {
"description": "my updated project",
"enabled": true,
"name": "myUpdatedProject"
}
}
Example of Response
HTTP/1.1 200 OK
Vary: X-Auth-Token
Content-Type: application/json
Content-Length: 299
Date: Tue, 02 Sep 2014 06:07:40 GMT
{
"project": {
"description": "my updated project",
"domain_id": "--domain-id--",
"enabled": true,
"extra": {},
"id": "--project-id--",
"links": {
"self": "http://identity.jp-east-1.cloud.global.fujitsu.com/v3/projects/--project-id--"
},
"name": "myUpdatedProject"
}
}