API_Description

<p><strong>1. ListAreas</strong></p> <p><strong>Interface Description</strong></p> <p>List District information by City Code</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>CityCode</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>City Code, referring to ListCities interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Areas</p> </td> <td> <p>List&lt;AreaBean&gt;</p> </td> <td> <p>District Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>2. ListCities</strong></p> <p><strong>Interface Description</strong></p> <p>List City information by Province Code</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ProvinceCode</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Province Code, referring to ListProvinces interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Cities</p> </td> <td> <p>List&lt;CityBean&gt;</p> </td> <td> <p>City Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>3. ListProvinces</strong></p> <p><strong>Interface Description</strong></p> <p>List Province information</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Provinces</p> </td> <td> <p>List&lt;ProvinceBean&gt;</p> </td> <td> <p>Province Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>4. ListResourceTypes</strong></p> <p><strong>Interface Description</strong></p> <p>Query Resource Type List</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ServiceType</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Service Type, referring to ListServiceType interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceTypes</p> </td> <td> <p>List&lt;ResourceTypeBean&gt;</p> </td> <td> <p>Resource Type Detail List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>5. ListServiceTypes</strong></p> <p><strong>Interface Description</strong></p> <p>Query Service Type List</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>Response Parameter</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ServiceTypes</p> </td> <td> <p>List&lt;ServiceTypeBean&gt;</p> </td> <td> <p>Service Type List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>6. ListDictItems</strong></p> <p><strong>Interface Description</strong></p> <p>Use the directory to retrieve content from Data Dictionary</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DictCode</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Data dictionary directory code</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>DictItems</p> </td> <td> <p>List&lt;DictItemBean&gt;</p> </td> <td> <p>Data dictionary List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>7. ListOperators</strong></p> <p><strong>Interface Description</strong></p> <p>Query Operator Information</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region uuid, referring to ListRegions interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Product Code, referring to ListProduct interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Operators</p> </td> <td> <p>List&lt;OperatorBean&gt;</p> </td> <td> <p>Operator List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>8. GetPrice</strong></p> <p><strong>Interface Description</strong></p> <p>Get price information for configuration upgrades/downgrades</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>OldProductSpecId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Old Product Specification ID, OldProductSpecId and OldProductSpecName cannot be null at the same time in configuration upgrades/downgrades</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductSpecId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Product Specification ID, ProductSpecId and ProductSpecName cannot be null at the same time</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OldProductSpecName</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Old Specification Name, OldProductSpecId and OldProductSpecName cannot be null at the same time in configuration upgrades/downgrades</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductSpecName</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Specification Name, ProductSpecId and ProductSpecName cannot be null at the same time</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Billing method Options Hour | Usage | PreUsage | Monthly | Free | Annual</p> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Region uuid, referring to ListRegions interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>OldPrices</p> </td> <td> <p>List&lt;PriceBean&gt;</p> </td> <td> <p>Old Configuration Price</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Prices</p> </td> <td> <p>List&lt;PriceBean&gt;</p> </td> <td> <p>New Configuration Price</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>9. ListProductSeries</strong></p> <p><strong>Interface Description</strong></p> <p>&nbsp; Query Product Series Information</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ProductId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Product ID, referring to ListProduct interface description for details. ProductId and ProductName cannot be null at the same time</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductName</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Product Name, referring to ListProduct interface description for details. Remove the Code in product information when passing value to ProductName. ProductId and ProductName cannot be null at the same time.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Region uuid, referring to ListRegions interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ZoneId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Available Zone uuid, referring to ListZones interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PodId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>High Available Zone uuid, referring to ListPods interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ProductSeries</p> </td> <td> <p>List&lt;ProductSeriesBean&gt;</p> </td> <td> <p>Product Series Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>10.&nbsp;ListProducts</strong></p> <p><strong>Interface Description</strong></p> <p>Query Product Information List</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Name</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Product Name</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Products</p> </td> <td> <p>List&lt;ProductBean&gt;</p> </td> <td> <p>Product Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>11.&nbsp;ListValidProducts</strong></p> <p><strong>Interface Description</strong></p> <p>Query valid products by access type</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>IntegratedType</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Product Access Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Products</p> </td> <td> <p>List&lt;ProductBean&gt;</p> </td> <td> <p>Product Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>12.&nbsp;ListRegions</strong></p> <p><strong>Interface Description</strong></p> <p>Query Regions</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Region uuid, when the id cannot be found in the system, all regions information will be returned by default</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Product Code, referring to ListProduct interface description for details.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Regions</p> </td> <td> <p>List&lt;RegionBean&gt;</p> </td> <td> <p>Region Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>13.&nbsp;ListZones</strong></p> <p><strong>Interface Description</strong></p> <p>Query Available Zone information list, return the Availability Zone Details given specified ID.</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Region uuid, referring to ListRegion interface description for details.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Id</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Available Zone uuid, referring to ListZones interface description for details.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Product Code, referring to ListProduct interface description for details.</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceTypeCode</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Resource Type Code, referring to ListResourceType interface description for details.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Zones</p> </td> <td> <p>List&lt;ZoneBean&gt;</p> </td> <td> <p>Available Zone Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>14.&nbsp;BatchTagResources</strong></p> <p><strong>Interface Description</strong></p> <p>Batch tag binding to relative resource</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Resource Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceIds</p> </td> <td> <p>String[]</p> </td> <td> <p>true</p> </td> <td> <p>Resource ID&nbsp; List</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Tags</p> </td> <td> <p>String[]</p> </td> <td> <p>true</p> </td> <td> <p>Tag List, e.g.[Tag Name 1:Tag Value 1&quot;,&quot; Tag Name 2:Tag Value 2&quot;,&quot; Tag Name 3:Tag Value 3&quot;]</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Region uuid, referring to ListRegions interface description for details.</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>15.&nbsp;CreateTags</strong></p> <p><strong>Interface Description</strong></p> <p>Create Tags</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Tag Types</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Tags</p> </td> <td> <p>String[]</p> </td> <td> <p>true</p> </td> <td> <p>Tag List, e.g.[Tag Name 1:Tag Value 1&quot;,&quot; Tag Name 2:Tag Value 2&quot;,&quot; Tag Name 3:Tag Value 3&quot;]</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagBeans</p> </td> <td> <p>List&lt;TagBean&gt;</p> </td> <td> <p>Tag Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>16.&nbsp;DeleteTags</strong></p> <p><strong>Interface Description</strong></p> <p>Delete Tags</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Tags</p> </td> <td> <p>String[]</p> </td> <td> <p>true</p> </td> <td> <p>List of Tag Key-Value Pairs, e.g.[Tag Name 1:Tag Value 1&quot;,&quot; Tag Name 2:Tag Value 2&quot;,&quot; Tag Name 3:Tag Value 3&quot;]</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>17.&nbsp;ListGlobalTags</strong></p> <p><strong>Interface Description</strong></p> <p>Query Global Tags</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagName</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Tag Name</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Resource Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Page Number Default Value: 1</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Page Size</p> <p>Default Value: 10 Maximum Value:3000</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderBy</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Sort Keywords, Options tagValue | tagName | tenantId | instanceCount | ebsCount | f5Count | lvxCount | vpcCount | caasCount</p> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderType</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Sorting Options, Options ASC | DESC</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagInfos</p> </td> <td> <p>List&lt;TagBean&gt;</p> </td> <td> <p>Tag Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total Number of Tag Information</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>18.&nbsp;ListTagInfos</strong></p> <p><strong>Interface Description</strong></p> <p>Query Tag Information</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagName</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Tag Name, referring to ListTagNames Interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Resource Type, referring to ListResourceType Interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>PageNumber Default Value:1</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Page Size</p> <p>Default Value: 10 Maximum Value:3000</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderBy</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Sort Keywords, Options tagValue | tagName | tenantId | instanceCount | ebsCount | f5Count | lvxCount | vpcCount | caasCount</p> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>OrderType</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Sorting Options, Options ASC | DESC</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Region uuid, referring to ListRegions Interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagInfos</p> </td> <td> <p>List&lt;TagBean&gt;</p> </td> <td> <p>Tag Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total Number of Tag Information</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>19.&nbsp;ListTagNames</strong></p> <p><strong>Interface Description</strong></p> <p>Query Tag Names</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Tag Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsTagged</p> </td> <td> <p>Boolean</p> </td> <td> <p>false</p> </td> <td> <p>Check if the tags have been bind to other resources. If returns true, list the tags with resources attached; if returns false, list all tags. Default value set to be true</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagNames</p> </td> <td> <p>List&lt;TagNameBean&gt;</p> </td> <td> <p>Tag Name Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>20. ListTagTypes</strong></p> <p><strong>Interface Description</strong></p> <p>Query Tag Types</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagTypes</p> </td> <td> <p>List&lt;String&gt;</p> </td> <td> <p>Tag Type List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>21.&nbsp;ListTagValues</strong></p> <p><strong>Interface Description</strong></p> <p>Query Tag Values</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagName</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Tag Name</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Tag Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>IsTagged</p> </td> <td> <p>Boolean</p> </td> <td> <p>false</p> </td> <td> <p>Check if the tags have been bind to other resources. If returns true, list the tags with resources attached; if returns false, list all tags. Default value set to true</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagValues</p> </td> <td> <p>List&lt;TagValueBean&gt;</p> </td> <td> <p>Tag Value List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>22.&nbsp;ListTags</strong></p> <p><strong>Interface Description</strong></p> <p>Query Tags</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Tag Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>Tags</p> </td> <td> <p>List&lt;TagNameBean&gt;</p> </td> <td> <p>Tag Name Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>23.&nbsp;ListTagsByResourceId</strong></p> <p><strong>Interface Description</strong></p> <p>Query Tags by Resource Id</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Tag Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Resource ID</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagBeans</p> </td> <td> <p>List&lt;TagBean&gt;</p> </td> <td> <p>Tag Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>24.&nbsp;TagResource</strong></p> <p><strong>Interface Description</strong></p> <p>Add Tags for specified Resource</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Tag Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Resource ID referring to ListResources</p> <p>for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Tags</p> </td> <td> <p>String[]</p> </td> <td> <p>true</p> </td> <td> <p>Tag List, e.g.[Tag Name 1:Tag Value 1&quot;,&quot; Tag Name 2:Tag Value 2&quot;,&quot; Tag Name 3:Tag Value 3&quot;]</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Region uuid, referring to ListRegions Interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>TagBeans</p> </td> <td> <p>List&lt;TagBean&gt;</p> </td> <td> <p>Tag Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>25.&nbsp;UntagResource</strong></p> <p><strong>Interface Description</strong></p> <p>Remove Tags for specified Resource</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Tag Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Resource ID referring to ListResources</p> <p>for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Tags</p> </td> <td> <p>String[]</p> </td> <td> <p>true</p> </td> <td> <p>Tag List, e.g.[Tag Name 1:Tag Value 1&quot;,&quot; Tag Name 2:Tag Value 2&quot;,&quot; Tag Name 3:Tag Value 3&quot;]</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>26.&nbsp;UpdateTags</strong></p> <p><strong>Interface Description</strong></p> <p>Update Tags</p> <p><strong>Request Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:0px"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Required (true/false)</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceType</p> </td> <td> <p>TagResourceType</p> </td> <td> <p>true</p> </td> <td> <p>Tag Type</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>ResourceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Resource ID referring to ListResources</p> <p>for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Tags</p> </td> <td> <p>String[]</p> </td> <td> <p>false</p> </td> <td> <p>Tag List, e.g.[Tag Name 1:Tag Value 1&quot;,&quot; Tag Name 2:Tag Value 2&quot;,&quot; Tag Name 3:Tag Value 3&quot;]</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Region uuid, referring to ListRegions Interface description for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table> <p><strong>Response Parameter</strong></p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> <p><strong>Parameter Name</strong></p> </td> <td> <p><strong>Parameter Type</strong></p> </td> <td> <p><strong>Parameter Description</strong></p> </td> <td> <p><strong>Remarks</strong></p> </td> </tr> <tr> <td> <p>ResourceId</p> </td> <td> <p>String</p> </td> <td> <p>Resource ID referring to ListResources for details</p> </td> <td> <p>&nbsp;</p> </td> </tr> <tr> <td> <p>Tags</p> </td> <td> <p>List&lt;TagBean&gt;</p> </td> <td> <p>Tag Information List</p> </td> <td> <p>&nbsp;</p> </td> </tr> </tbody> </table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products