10349: Add "Create a collection sharing link"
[arvados.git] / doc / sdk / python / cookbook.html.textile.liquid
1 ---
2 layout: default
3 navsection: sdk
4 navmenu: Python
5 title: Code cookbook
6 ...
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 h2. Cancel a container request
14
15 <code>
16 import arvados
17 arvados.api().container_requests().update(uuid=container_request_uuid, body={"priority": 0}).execute()
18 </code>
19
20 h2. Cancel all container requests
21
22 <code>
23 import arvados
24 api = arvados.api()
25 result = api.container_requests().list(filters=[["state", "=", "Committed"], ["priority", ">", "0"]]).execute()["items"]
26 for container_request in result:
27     api.container_requests().update(uuid=container_request["uuid"], body={"priority": 0}).execute()
28 </code>
29
30 h2. List completed container requests
31
32 <code>
33 import arvados
34 api = arvados.api()
35 result = api.container_requests().list(filters=[["name", "like", name], ["state", "=", "Final"]]).execute()["items"]
36 container_uuids = [cr["container_uuid"] for cr in result]
37 containers = api.containers().list(filters=[["uuid", "in", container_uuids]]).execute()["items"]
38 container_dict = {c["uuid"]: c for c in containers}
39
40 for container_request in result:
41     container = container_dict[container_request["container_uuid"]]
42     print("%s, %s, %s" % (container_request["uuid"], container_request["name"], "Success" if container["exit_code"] == 0 else "Failed"))
43 </code>
44
45 h2. Get input of a CWL workflow
46
47 <code>
48 import arvados
49 api = arvados.api()
50 container_request = arvados.api().container_requests().get(uuid=container_request_uuid).execute()
51 print(container_request["mounts"]["/var/lib/cwl/cwl.input.json"])
52 </code>
53
54 h2. Get output of a CWL workflow
55
56 <code>
57 import arvados
58 import arvados.collection
59 api = arvados.api()
60 container_request = arvados.api().container_requests().get(uuid=container_request_uuid).execute()
61 collection = arvados.collection.CollectionReader(container_request["output_uuid"])
62 print(collection.open("cwl.output.json").read())
63 </code>
64
65 h2. Create a collection sharing link
66
67 <code>
68 import arvados
69 api = arvados.api()
70 download="https://your.download.server"
71 collection_uuid="your-4zz18-collectionuuid"
72 token = api.api_client_authorizations().create(body={"api_client_authorization":{"scopes": [
73     "GET /arvados/v1/collections/%s" % collection_uuid,
74     "GET /arvados/v1/collections/%s/" % collection_uuid,
75     "GET /arvados/v1/keep_services/accessible"]}}).execute()
76 print("%s/c=%s/t=%s/_/" % (download, collection_uuid, token["api_token"]))
77 </code>
78
79 h2. Run a CWL workflow from a workflow record