Update CICs

Summary

Update contract informations of CIC.

Type

  • Update

Target object of API

  • CIC

Synchronous/Asynchronous

  • Synchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{api_endpoint}/v1.0/ecc/mCICs/{mcic_id}/CICs/{cic_id}

HTTP Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>

HTTP Request Body

Parameters

Input Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
token_id Header authentication token string(varchar) keystone authentication token required   Terminate 401
mcic_id URL String(15) It identifies mCIC uniquely required   Terminate 404
cic_id URL String(20) It identifies CIC uniquely required   Terminate 404
cic_name Body String(1-255) CIC friendly name optional      

Response

Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 200 OK)
  • <response_code>: see "HTTP Responses" section

  • <message>: message based on the response code

    • skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"

Response Code

Response Codes
response code condition
200 normal end
400 bad request
401 unauthorized
404 not found
409 conflicted
500 internal server error

Response Body

Format

None.

Parameters

None.

Sample Request and Response

Sample API request

Request URI

http://{api_endpoint}/v1.0/ecc/mCICs/CIC-JP-A0000001/CICs/CIC-JP-A0000001-0001

Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: 69105c889f824efdafb56af224208ad4

Request Body

{
  "cic_name": "name"
}

Sample API response

Response Header

HTTP/1.1 200 OK
  • <response_code>: see "HTTP Responses" section

  • <message>: message based on the response code

    • skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"

Response Body

None.

Example error message

HTTP request

PUT /v1.0/ecc/mCICs/CIC-JP-A0000000/CICs/CIC-JP-A0000000-0000 HTTP/1.1
User-Agent: curl/7.37.1
Host: 192.168.150.71:9001
Content_type:application/json
Accept:application/json
X-Auth-Token:4e54395a12b740d585d74190ba4eb14b
Content-Length: 20
Content-Type: application/x-www-form-urlencoded

HTTP Response

HTTP/1.1 404 HTTP 404: Not Found
Server: nginx/1.8.0
Date: Mon, 28 Sep 2015 10:12:54 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 56
Connection: keep-alive

{
    "cause": "Could not found mCIC. CIC-JP-A0000000"
}