forked from docs/doc-exports
Su, Xiaomeng
483e5cc6cc
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
170 lines
13 KiB
HTML
170 lines
13 KiB
HTML
<a name="dli_02_0258"></a><a name="dli_02_0258"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Global Variable</h1>
|
|
<div id="body1586938061410"><div class="section" id="dli_02_0258__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0258__a4deaa8ebc392424e869c47835399ab23">This API is used to create a global variable.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0258__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0258__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0258__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0258__ab9f59a1049d24cb2a9c51b9ed06e59d4"><a name="dli_02_0258__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>POST /v1.0/{project_id}/variables</p>
|
|
</li><li id="dli_02_0258__lab001edff5ca4cde843db03812f0979d">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0258__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0258__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="15.690000000000001%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0258__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.879999999999999%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0258__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.44%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0258__p1311394819612">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.99000000000001%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0258__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0258__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="15.690000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0258__a2b526eb27eb241248b0586fd54086598">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.879999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0258__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.44%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0258__p611474819616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.99000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0258__p1768719515356">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0258__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0258__tcedd9d5bece544898da42c15fe855a72" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0258__r263212cfc24b4f7ab11ba179dc95f8d5"><th align="left" class="cellrowborder" valign="top" width="20.849999999999998%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0258__aa71bb56aa6ba48488d66e68a44744488">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.120000000000001%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0258__adfb457c202dc4709b315aa6d0a384fdf">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.64%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0258__a07ad11538b854ab4997a0c69b2fa1ff5">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.38999999999999%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0258__a27603242143846be8ed4173686b0b27b">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0258__rab514ea502754f9d88a6ca5cd27e6f9b"><td class="cellrowborder" valign="top" width="20.849999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0258__p1955111171319">var_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.120000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0258__a3f01c30693ef41f9ab8913a733a8dcae">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0258__a4c806296e81547638d0ed294d9a3ca63">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0258__p16532315141">A global variable name can contain a maximum of 128 characters, including only digits, letters, and underscores (_), but cannot start with an underscore (_) or contain only digits. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0258__rd59ae95756ea47c28d7aa24b2a057881"><td class="cellrowborder" valign="top" width="20.849999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0258__p60911214151446">var_value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.120000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0258__a3db6910eff34455caa5af7c1be07ff39">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0258__a3b4b1f2ddd81469dbc22dc9de316fc9b">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0258__p196511317147">Global variable value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0258__rc32461e6ae584faebd86e6a27d35ad52"><td class="cellrowborder" valign="top" width="20.849999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0258__p45216947151446">is_sensitive</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.120000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0258__aa5ebc166527543019d7799ddf643663f">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0258__ad6a32cc0ba694cea9fe5f132dd482a0b">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.38999999999999%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0258__p764813312144">Whether to set a variable as a sensitive variable. The default value is <strong id="dli_02_0258__b117395720114">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0258__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0258__t5995d65f65ba4ebca8606202112b407e" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0258__ra7acea51e4b4437e917d21fe99f130a3"><th align="left" class="cellrowborder" valign="top" width="19.25%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0258__a5af940f2267747ef871c67c86a0be82e">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.44%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0258__abcfbd3a651704d539626f3a41cc744f5">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.370000000000001%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0258__a2351d8d266444ad3ad1c09540d6d81cc">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.94%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0258__af7ea6a3f59844bdf99d51e90d570be4c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0258__row2418154742"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0258__p2827183519">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0258__p6362111364911">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0258__p118601817517">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.94%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0258__p1487318359">Indicates whether the request is successfully executed. Value <strong id="dli_02_0258__b13231728131220">true</strong> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0258__row64180541741"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0258__a4aba020b918e457a8a3d15e7ebaeb20d">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0258__p11374111319494">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0258__ac85edc0a27d044b0ad524a4124e59e4c">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.94%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0258__ac087aec9dfcc407ba244ad3e96b23257">Message content.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0258__section173012132418"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0258__p105114818571">Create a global variable that is sensitive.</p>
|
|
<pre class="screen" id="dli_02_0258__screen17915151213913">{
|
|
"var_name": "string",
|
|
"var_value": "string",
|
|
"is_sensitive": true
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0258__section1439118120914"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0258__screen3128586398">{
|
|
"is_success": true,
|
|
"message": "string"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0258__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0258__acef1445366354016b2ed90921927a555"><a href="#dli_02_0258__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 4</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0258__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0258__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0258__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0258__afa33b7f5b0ac4d008ebcf6493f629b24">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0258__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0258__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0258__a8c63a97e3bad402ebaead0bd99cad632">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0258__p828449123817">A variable is created successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0258__row264510302300"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0258__p19646163033015">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0258__p47552616316">The input parameter is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0258__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0258__dli_02_0225_p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see <a href="dli_02_0056.html">Error Codes</a>.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0258__dli_02_0225_table847819307387" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Error codes</caption><thead align="left"><tr id="dli_02_0258__dli_02_0225_row2479163016383"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.8.3.2.3.1.1"><p id="dli_02_0258__dli_02_0225_p114796309389">Error Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.8.3.2.3.1.2"><p id="dli_02_0258__dli_02_0225_p1647973053817">Error Message</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0258__dli_02_0225_row1047920308387"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.3.2.3.1.1 "><p id="dli_02_0258__p55041261710">DLI.0001</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.8.3.2.3.1.2 "><p id="dli_02_0258__p1448812131714">Parameter check errors occur.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0258__row1065313588322"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.3.2.3.1.1 "><p id="dli_02_0258__p13654145813214">DLI.0999</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.8.3.2.3.1.2 "><p id="dli_02_0258__p165445883213">The object exists.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0257.html">Global Variable-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|