8073f07e6e35139b5cd6e7a1993c617e5cfc6be8
[cli.git] /
1 open_cli_schema_version: 1.0
2 name: service-create
3 description: Create a service instance using MSO
4
5 info:
6   product: onap-amsterdam
7   service: so
8   author: ONAP CLI Team onap-discuss@lists.onap.org
9
10 parameters:
11   - name: cloud-region
12     description: cloud region identifier
13     type: string
14     short_option: l
15     long_option: cloud-region
16     is_optional: false
17   - name: tenant-id
18     description: tenant id
19     type: string
20     short_option: b
21     long_option: tenant-id
22     is_optional: false
23   - name: model-invariant-id
24     description: model invariant id generated by ASDC.
25     type: string
26     short_option: e
27     long_option: model-invariant-id
28     is_optional: false
29   - name: model-uuid
30     description: model uuid generated by ASDC.
31     type: string
32     short_option: g
33     long_option: model-uuid
34     is_optional: false
35   - name: model-name
36     description: model name as provided in ASDC design time.
37     type: string
38     short_option: i
39     long_option: model-name
40     is_optional: false
41   - name: model-version
42     description: model-version
43     type: string
44     short_option: j
45     long_option: model-version
46     is_optional: false
47   - name: customer
48     description: unique id for customer
49     type: string
50     short_option: c
51     long_option: customer
52     is_optional: false
53   - name: instance-name
54     description: service instance name
55     type: string
56     short_option: k
57     long_option: instance-name
58     is_optional: false
59   - name: supress-rollback
60     description: rollback changes if instantiation fails.
61     type: bool
62     short_option: r
63     long_option: supress-rollback
64     is_optional: true
65   - name: service-type
66     description: subscription service type
67     type: string
68     short_option: w
69     long_option: service-type
70     is_optional: false
71
72 results:
73   direction: portrait
74   attributes:
75     - name: service-id
76       description: instance id for the created service.
77       type: string
78       scope: short
79
80
81 http:
82   service:
83     name: so
84     version: v3
85     auth: basic
86     mode: direct
87   request:
88     uri: /ecomp/mso/infra/serviceInstances/v3
89     method: POST
90     body: '{"requestDetails": {"cloudConfiguration" : {"lcpCloudRegionId": "${cloud-region}","tenantId": "${tenant-id}"},"modelInfo": {"modelType": "service","modelInvariantId": "${model-invariant-id}","modelNameVersionId": "${model-uuid}","modelName": "${model-name}","modelVersion": "${model-version}"},"subscriberInfo": {"globalSubscriberId": "${customer}"},"requestInfo": {"instanceName": "${instance-name}","source": "VID","suppressRollback": "${supress-rollback}"},"requestParameters": {"subscriptionServiceType": "${service-type}"}}}'
91
92   success_codes:
93     - 202
94   result_map:
95     service-id: $b{$.requestReferences.instanceId}
96   sample_response:
97     body: '{"requestReferences":{"instanceId":"${instance-id}","requestId":"375ba428-65e7-4f2b-afb9-74735ac6bfd0"}}'