doc-exports/docs/dli/api-ref/dli_02_0298.html
Su, Xiaomeng 483e5cc6cc dli_api_20240430
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>
2024-05-15 12:04:03 +00:00

170 lines
13 KiB
HTML

<a name="dli_02_0298"></a><a name="dli_02_0298"></a>
<h1 class="topictitle1">Obtaining DLI Agency Information (Discarded)</h1>
<div id="body1596422865256"><div class="section" id="dli_02_0298__section18998185384911"><h4 class="sectiontitle">Function</h4><p id="dli_02_0298__p342141019132">This API is used to obtain the agency information of a DLI user.</p>
<div class="note" id="dli_02_0298__note794562214412"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0298__p69451622184111">This API has been discarded and is not recommended.</p>
</div></div>
</div>
<div class="section" id="dli_02_0298__s9e1b8ec5b57c422a942b19835da7d66e"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0298__en-us_topic_0069077927_ul10082125"><li id="dli_02_0298__en-us_topic_0069077927_li23630265">URI format<p id="dli_02_0298__en-us_topic_0069077927_p11345797"><a name="dli_02_0298__en-us_topic_0069077927_li23630265"></a><a name="en-us_topic_0069077927_li23630265"></a>GET /v2/{project_id}/agency</p>
</li><li id="dli_02_0298__li1725612218454">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0298__en-us_topic_0069077803_table60779388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0298__en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="13.900000000000002%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0298__a420a62a594f9410eaea229ffc8037a61">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.42%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0298__en-us_topic_0069077803_p873025824211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.27%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0298__p1020675622515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.41%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0298__a692d3cd97b464aed90ba6d841900a4a5">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0298__en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0298__en-us_topic_0069077803_p43412436">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.42%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0298__en-us_topic_0069077803_p26746391">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.27%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0298__p11207155615251">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.41%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0298__p1310472724012">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_0298__section20458182103"><h4 class="sectiontitle">Request</h4><p id="dli_02_0298__p7700715105011">None</p>
</div>
<div class="section" id="dli_02_0298__sd1ecb66580054b2ea403be8b2272a2c7"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0298__en-us_topic_0069077927_table56638444" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0298__en-us_topic_0069077927_row48911609"><th align="left" class="cellrowborder" valign="top" width="19.79%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0298__ae076f6b3f1bf463b9cc087fc566253d5">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.43%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0298__p12583123083811">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.9%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0298__a59685f4525af4d82a623288ff8ccb0f4">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.88%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0298__en-us_topic_0069077927_p632718127368">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0298__en-us_topic_0069077927_row27919264"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0298__en-us_topic_0069077927_p46867877">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0298__p9584230133817">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0298__en-us_topic_0069077927_p7327597">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0298__en-us_topic_0069077927_p56664447">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0298__parmvalue3278141173716"><b>true</b></span> indicates that the request is successfully executed.</p>
</td>
</tr>
<tr id="dli_02_0298__en-us_topic_0069077927_row40217981"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0298__en-us_topic_0069077927_p36431005">message</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0298__p95842301382">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0298__en-us_topic_0069077927_p49163111">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0298__a4fa277540d3e42e48cec2027a36ca6bc">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
</td>
</tr>
<tr id="dli_02_0298__row201938224388"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0298__p519319226387">version</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0298__p1419332213385">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0298__p18194192210383">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0298__p2194152217388">Agency version information.</p>
</td>
</tr>
<tr id="dli_02_0298__row1155484311388"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0298__p0554144317381">current_roles</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0298__p355404393815">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0298__p05545432381">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0298__p16931946132711">Role. The supported values are as follows:</p>
<p id="dli_02_0298__p182131549142713"><strong id="dli_02_0298__b133219573166">obs_adm</strong>: Administrator permissions for accessing and using the Object Storage Service.</p>
<p id="dli_02_0298__p32161951132714"><strong id="dli_02_0298__b1262411235111">dis_adm</strong>: Administrator permissions for using Data Ingestion Service data as the data source</p>
<p id="dli_02_0298__p817611535273"><strong id="dli_02_0298__b32431420131220">ctable_adm</strong>: Administrator permissions for accessing and using the CloudTable service</p>
<p id="dli_02_0298__p1796095411272"><strong id="dli_02_0298__b137177529120">vpc_netadm</strong>: Administrator permissions for using the Virtual Private Cloud service</p>
<p id="dli_02_0298__p689325622710"><strong id="dli_02_0298__b16301847111320">smn_adm</strong>: Administrator permissions for using the Simple Message Notification service</p>
<p id="dli_02_0298__p45541431386"><strong id="dli_02_0298__b17928113811158">te_admin</strong>: Tenant Administrator permissions</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0298__section15772143623410"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0298__p534664283414">None</p>
</div>
<div class="section" id="dli_02_0298__section17446171164041"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0298__screen4559121772114">{
"is_success": true,
"message": "",
"version": "v2",
"current_roles": [
"ctable_adm",
"vpc_netadm",
"ief_adm",
"dis_adm",
"smn_adm",
"obs_adm"
]
}</pre>
</div>
<div class="section" id="dli_02_0298__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0298__acef1445366354016b2ed90921927a555"><a href="#dli_02_0298__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 3</a> describes status codes.</p>
<div class="tablenoborder"><a name="dli_02_0298__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0298__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status codes</caption><thead align="left"><tr id="dli_02_0298__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0298__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_0298__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0298__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0298__a8c63a97e3bad402ebaead0bd99cad632">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0298__p528373855714">The agency information is obtained.</p>
</td>
</tr>
<tr id="dli_02_0298__row1012873412149"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0298__p1912813348145">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0298__p154287617445">Request failure.</p>
</td>
</tr>
<tr id="dli_02_0298__row85081627195515"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0298__p650915272550">404</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0298__p2509112711552">Not found.</p>
</td>
</tr>
<tr id="dli_02_0298__row85241345185417"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0298__p18525104516548">500</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0298__p1525345155412">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0298__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0298__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_0298__dli_02_0225_table847819307387" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Error codes</caption><thead align="left"><tr id="dli_02_0298__dli_02_0225_row2479163016383"><th align="left" class="cellrowborder" valign="top" width="14.299999999999999%" id="mcps1.3.8.3.2.3.1.1"><p id="dli_02_0298__dli_02_0225_p114796309389">Error Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85.7%" id="mcps1.3.8.3.2.3.1.2"><p id="dli_02_0298__dli_02_0225_p1647973053817">Error Message</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0298__dli_02_0225_row1047920308387"><td class="cellrowborder" valign="top" width="14.299999999999999%" headers="mcps1.3.8.3.2.3.1.1 "><p id="dli_02_0298__p113714404567">DLI.0002</p>
</td>
<td class="cellrowborder" valign="top" width="85.7%" headers="mcps1.3.8.3.2.3.1.2 "><p id="dli_02_0298__p8324115965715">The object does not exist.</p>
</td>
</tr>
<tr id="dli_02_0298__row342113312412"><td class="cellrowborder" valign="top" width="14.299999999999999%" headers="mcps1.3.8.3.2.3.1.1 "><p id="dli_02_0298__p4422332417">DLI.0999</p>
</td>
<td class="cellrowborder" valign="top" width="85.7%" headers="mcps1.3.8.3.2.3.1.2 "><p id="dli_02_0298__p1251850191316">An internal error occurre</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0297.html">Agency-related APIs (Discarded)</a></div>
</div>
</div>