14.3. Activate a Deployment of an Application

Description

Activate a particular deployment for the specified application.

Method and URL Structure

Expand

Method	Resource URL
`POST`	`/broker/rest/application/:id/events`

Request Parameters

Expand

Name	Description	Required	Default
`event`	Event	Yes
`deployment_id`	Deployment ID to activate the application	Yes

See Section A.8, “Deployments” for more information about the valid options applicable to these request parameters.

Request

{
  "event": "activate",
  "deployment_id": "f36f59c0"
}

{
  "event": "activate",
  "deployment_id": "f36f59c0"
}

Copy to Clipboard

Toggle word wrap

cURL Command Example

curl -X POST https://openshift.redhat.com/broker/rest/application/528424f6dbd93c204d000001/events --user user@example.com:password --data-urlencode event=activate --data-urlencode deployment_id=56e71f70

$ curl -X POST https://openshift.redhat.com/broker/rest/application/528424f6dbd93c204d000001/events --user user@example.com:password --data-urlencode event=activate --data-urlencode deployment_id=56e71f70

Copy to Clipboard

Toggle word wrap

JSON Response

The API returns the application resource. Unnecessary information and related resource links returned by the API have been removed for brevity. See Chapter 11, Applications for more information on all application parameters.

{
    "api_version": 1.6,
    "data": {
        "aliases": [],
        "app_url": "http://myapp-mydomain.rhcloud.com/",
        "auto_deploy": true,
        "build_job_url": null,
        "building_app": null,
        "building_with": null,
        "creation_time": "2013-11-14T01:18:46Z",
        "deployment_branch": "master",
        "deployment_type": "git",
        "domain_id": "mydomain",
        "embedded": {},
        "framework": "php-5.4",
        "gear_count": 1,
        "gear_profile": "small",
        "git_url": "ssh://528424f6dbd93c204d000001@myapp-mydomain.rhcloud.com/~/git/myapp.git/",
        "health_check_path": "health_check.php",
        "id": "528424f6dbd93c204d000001",
        "initial_git_url": null,
        "keep_deployments": 10,
        "links": {
            "GET": {
                "href": "https://openshift.redhat.com/broker/rest/application/528424f6dbd93c204d000001",
                "method": "GET",
                "optional_params": [],
                "rel": "Get application",
                "required_params": []
            },
       
        },
        "members": [
            {
                "explicit_role": null,
                "from": [
                    {
                        "type": "domain",
                        "role": "admin"
                    }
                ],
                "id": "520bd6bbdbd93c3dee00000d",
                "login": "user@example.com",
                "owner": true,
                "role": "admin",
                "type": "user"
            },

        ],
        "name": "myapp",
        "scalable": false,
        "ssh_url": "ssh://528424f6dbd93c204d000001@myapp-mydomain.rhcloud.com"
    },
    "messages": [
        {
            "exit_code": 0,
            "field": null,
            "index": null,
            "severity": "info",
            "text": "Deployment ID 56e71f70 on application myapp has been activated"
        }
    ],
    "status": "ok",
    "supported_api_versions": [
	    1.0,
	    1.1,
	    1.2,
	    1.3,
	    1.4,
	    1.5,
	    1.6
	  ],
	  "type": "application",
	  "version": "1.6"
}

{
    "api_version": 1.6,
    "data": {
        "aliases": [],
        "app_url": "http://myapp-mydomain.rhcloud.com/",
        "auto_deploy": true,
        "build_job_url": null,
        "building_app": null,
        "building_with": null,
        "creation_time": "2013-11-14T01:18:46Z",
        "deployment_branch": "master",
        "deployment_type": "git",
        "domain_id": "mydomain",
        "embedded": {},
        "framework": "php-5.4",
        "gear_count": 1,
        "gear_profile": "small",
        "git_url": "ssh://528424f6dbd93c204d000001@myapp-mydomain.rhcloud.com/~/git/myapp.git/",
        "health_check_path": "health_check.php",
        "id": "528424f6dbd93c204d000001",
        "initial_git_url": null,
        "keep_deployments": 10,
        "links": {
            "GET": {
                "href": "https://openshift.redhat.com/broker/rest/application/528424f6dbd93c204d000001",
                "method": "GET",
                "optional_params": [],
                "rel": "Get application",
                "required_params": []
            },
       
        },
        "members": [
            {
                "explicit_role": null,
                "from": [
                    {
                        "type": "domain",
                        "role": "admin"
                    }
                ],
                "id": "520bd6bbdbd93c3dee00000d",
                "login": "user@example.com",
                "owner": true,
                "role": "admin",
                "type": "user"
            },

        ],
        "name": "myapp",
        "scalable": false,
        "ssh_url": "ssh://528424f6dbd93c204d000001@myapp-mydomain.rhcloud.com"
    },
    "messages": [
        {
            "exit_code": 0,
            "field": null,
            "index": null,
            "severity": "info",
            "text": "Deployment ID 56e71f70 on application myapp has been activated"
        }
    ],
    "status": "ok",
    "supported_api_versions": [
	    1.0,
	    1.1,
	    1.2,
	    1.3,
	    1.4,
	    1.5,
	    1.6
	  ],
	  "type": "application",
	  "version": "1.6"
}

Copy to Clipboard

Toggle word wrap

맨 위로 이동

이 콘텐츠는 선택한 언어로 제공되지 않습니다.

14.3. Activate a Deployment of an Application

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat 소개

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links