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