CBR API DOC

Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
This commit is contained in:
zhangyue 2023-09-04 07:52:09 +00:00 committed by zuul
parent 7505fe85a9
commit babba11972
22 changed files with 1340 additions and 1320 deletions

File diff suppressed because it is too large Load Diff

View File

@ -87,6 +87,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Project IDs of the backup share members to be added</p>
<p>Array Length: <strong>1 - 10</strong></p>
</td>
</tr>
</tbody>

View File

@ -78,6 +78,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Array of <a href="#AddVaultResource__request_ResourceCreate">ResourceCreate</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Resource list</p>
<p>Array Length: <strong>1 - 256</strong></p>
</td>
</tr>
</tbody>

View File

@ -1,7 +1,7 @@
<a name="BatchCreateAndDeleteVaultTags"></a><a name="BatchCreateAndDeleteVaultTags"></a>
<h1 class="topictitle1">Batch Adding or Deleting Tags of a Vault</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to batch add or delete tags for a specified instance. TMS uses this API to manage service resource tags. A resource can have a maximum of 10 tags. This API is idempotent. If there are duplicate keys in the request body when you add tags, an error is reported. If a to-be-added tag has the same key as an existing tag, the tag will be added and overwrite the existing tag. When deleting tags, you can upload duplicate keys. When deleting tags, if some tags do not exist, the deletion is considered to be successful by default. The character set of the tags will not be verified. A key and a value can individually consist of up to 127 and 255 characters. When you delete tags, the tags structure cannot be missing, and the key cannot be left blank or be an empty string.</p>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to batch add or delete tags for a specified instance. TMS uses this API to manage service resource tags. A resource can have a maximum of 20 tags. This API is idempotent. If there are duplicate keys in the request body when you add tags, an error is reported. If a to-be-added tag has the same key as an existing tag, the tag will be added and will overwrite the existing tag. When deleting tags, duplicate keys are allowed. When deleting tags, if some tags do not exist, the deletion is considered to be successful by default. The character set of the tags will not be verified. A key and a value can each consist of up to 127 and 255 characters. When you delete tags, the tags structure cannot be missing, and the key cannot be left blank or be an empty string.</p>
</div>
<div class="section" id="BatchCreateAndDeleteVaultTags__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v3/{project_id}/vault/{vault_id}/tags/action</p>
@ -56,7 +56,7 @@
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Tag list</p>
<p>This list cannot be an empty list.</p>
<p>The list can contain up to 10 keys.</p>
<p>The list can contain up to 20 keys.</p>
<p>Keys in this list must be unique.</p>
</td>
</tr>
@ -190,7 +190,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Tags</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000008.html">Tags</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -175,6 +175,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p>Array of <a href="#CreateCheckpoint__request_Resource">Resource</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p>Resource details</p>
<p>Array Length: <strong>0 - 256</strong></p>
</td>
</tr>
</tbody>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,7 +1,7 @@
<a name="CreateVaultTags"></a><a name="CreateVaultTags"></a>
<h1 class="topictitle1">Adding a Tag to an Associated Resource</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to add a tag to an associated resource. A resource can have a maximum of 10 tags. This API is idempotent. If a to-be-added tag has the same key as an existing tag, the tag will be added and overwrite the existing tag.</p>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to add a tag to an associated resource. A resource can have a maximum of 20 tags. This API is idempotent. If a to-be-added tag has the same key as an existing tag, the tag will be added and will overwrite the existing tag.</p>
</div>
<div class="section" id="CreateVaultTags__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v3/{project_id}/vault/{vault_id}/tags</p>
@ -170,7 +170,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Tags</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000008.html">Tags</a></div>
</div>
</div>

View File

@ -106,7 +106,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Tags</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000008.html">Tags</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -150,7 +150,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Tags</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000008.html">Tags</a></div>
</div>
</div>

View File

@ -54,12 +54,13 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Array of <a href="#ShowVaultResourceInstances__request_TagsReq">TagsReq</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of included tags. Backups with these tags will be filtered.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of included tags</p>
<p>This list cannot be an empty list.</p>
<p>The list can contain up to 10 keys.</p>
<p>The list can contain up to 20 keys.</p>
<p>Keys in this list must be unique.</p>
<p>The response returns resources containing any tags in this list. Keys in this list are in an AND relationship while values in each <strong>key-value</strong> structure is in an OR relationship.</p>
<p>If no tag filtering condition is specified, full data is returned.</p>
<p>Values in this list are in an AND relationship.</p>
<p>The response returns resources containing all tags in this list. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship.</p>
<p>If no filtering condition is specified, full data is returned.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>tags_any</p>
@ -68,12 +69,12 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Array of <a href="#ShowVaultResourceInstances__request_TagsReq">TagsReq</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of tags. Backups with any tags in this list will be filtered.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of any included tags</p>
<p>This list cannot be an empty list.</p>
<p>The list can contain up to 10 keys.</p>
<p>The list can contain up to 20 keys.</p>
<p>Keys in this list must be unique.</p>
<p>The response returns resources containing any tags in this list. Keys in this list are in an OR relationship while values in each <strong>key-value</strong> structure is in an OR relationship.</p>
<p>If no tag filtering condition is specified, full data is returned.</p>
<p>The response returns resources containing any tag in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.</p>
<p>If no filtering condition is specified, full data is returned.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>not_tags</p>
@ -82,12 +83,12 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Array of <a href="#ShowVaultResourceInstances__request_TagsReq">TagsReq</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of excluded tags. Backups without these tags will be filtered.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of excluded tags</p>
<p>This list cannot be an empty list.</p>
<p>The list can contain up to 10 keys.</p>
<p>The list can contain up to 20 keys.</p>
<p>Keys in this list must be unique.</p>
<p>The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each <strong>key-value</strong> structure is in an OR relationship.</p>
<p>If no tag filtering condition is specified, full data is returned.</p>
<p>The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship.</p>
<p>If no filtering condition is specified, full data is returned.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>not_tags_any</p>
@ -96,12 +97,12 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Array of <a href="#ShowVaultResourceInstances__request_TagsReq">TagsReq</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of tags. Backups without any tags in this list will be filtered.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of any excluded tags</p>
<p>This list cannot be an empty list.</p>
<p>The list can contain up to 10 keys.</p>
<p>The list can contain up to 20 keys.</p>
<p>Keys in this list must be unique.</p>
<p>The response returns resources without any tags in this list. Keys in this list are in an OR relationship while values in each <strong>key-value</strong> structure is in an OR relationship.</p>
<p>If no tag filtering condition is specified, full data is returned.</p>
<p>The response returns resources without any tags in this list. Keys in this list are in an OR relationship while values in each key-value structure is in an OR relationship.</p>
<p>If no filtering condition is specified, full data is returned.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>limit</p>
@ -200,14 +201,14 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>List of values</p>
<p>The list can contain up to 10 values.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Lists the values</p>
<p>The list can contain up to 20 values.</p>
<p>A tag value contains up to 255 Unicode characters. Spaces before and after a key will be deprecated.</p>
<p>Values in this list must be unique.</p>
<p>Values in this list are in an OR relationship.</p>
<p>This list can be empty and each value can be an empty character string.</p>
<p>If this list is left blank, it indicates that all values are included.</p>
<p>The asterisk (*) is a reserved character in the system. If the value starts with *, it indicates that fuzzy match is performed based on the value following *. The value cannot contain only asterisks.</p>
<p>An empty value list means any values.</p>
<p>* is a reserved character in the system. If the value starts with *, fuzzy match is performed based on the value following *. The value cannot contain only *.</p>
</td>
</tr>
</tbody>
@ -792,7 +793,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Tags</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000008.html">Tags</a></div>
</div>
</div>

View File

@ -167,7 +167,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Tags</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000008.html">Tags</a></div>
</div>
</div>

View File

@ -19,7 +19,7 @@
</li>
<li class="ulchildlink"><strong><a href="topic_300000006.html">Policies</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000007.html">Tags</a></strong><br>
<li class="ulchildlink"><strong><a href="topic_300000008.html">Tags</a></strong><br>
</li>
</ul>
</div>

View File

@ -1,18 +1,18 @@
<a name="cbr_04_0017"></a><a name="cbr_04_0017"></a>
<h1 class="topictitle1">Introduction</h1>
<div id="body1560824244020"><p id="cbr_04_0017__p1773914613588">This section describes fine-grained permissions management for your CBR. If your cloud account does not need individual IAM users, skip this section.</p>
<p id="cbr_04_0017__p373917464584">By default, new IAM users do not have permissions assigned. You need to add the users to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.</p>
<p id="cbr_04_0017__p1673974695813">You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
<div class="note" id="cbr_04_0017__note123212015590"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cbr_04_0017__p14302113443017">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
<div id="body1560824244020"><p id="cbr_04_0017__p1773914613588">You can use Identity and Access Management (IAM) for fine-grained permissions management of your CBR resources. If your account does not need individual IAM users, you can skip this section.</p>
<p id="cbr_04_0017__p373917464584">New IAM users do not have any permissions assigned by default. You need to first add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups and can perform specified operations on cloud services based on the permissions they have been assigned.</p>
<p id="cbr_04_0017__p1673974695813">You can grant users permissions using roles and policies. Roles are provided by IAM to define service-based permissions that match user's job responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
<div class="note" id="cbr_04_0017__note123212015590"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cbr_04_0017__p14302113443017">If you want to allow or deny the access to an API, use policy-based authorization.</p>
</div></div>
<p id="cbr_04_0017__p854170135912">An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the <strong id="cbr_04_0017__b69591852141716">ecs:servers:list</strong> action.</p>
<div class="section" id="cbr_04_0017__section127131913896"><h4 class="sectiontitle">Supported Actions</h4><p id="cbr_04_0017__p1024315617012">CBR provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. The following are common concepts related to policies:</p>
<ul id="cbr_04_0017__ul831515201117"><li id="cbr_04_0017__li1431518203113">Permissions: Statements in a policy that allow or deny certain operations.</li><li id="cbr_04_0017__li1466413303198">APIs: REST APIs that can be called by a user who has been granted specific permissions.</li><li id="cbr_04_0017__li123156201611">Actions: Specific operations that are allowed or denied.</li><li id="cbr_04_0017__li120995613199">Related actions: Actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the related actions.</li><li id="cbr_04_0017__li32219129202">IAM: Type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. </li><li id="cbr_04_0017__li6814564819"><div class="note" id="cbr_04_0017__note1864518486"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cbr_04_0017__p181245144817">The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.</p>
<p id="cbr_04_0017__p854170135912">Each account has all the permissions required to call all APIs, but IAM users must be granted the required permissions. The required permissions are determined by the actions supported by the API. Only users with the policies allowing for those actions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the <strong id="cbr_04_0017__b69591852141716">ecs:servers:list</strong> action.</p>
<div class="section" id="cbr_04_0017__section127131913896"><h4 class="sectiontitle">Supported Actions</h4><p id="cbr_04_0017__p1024315617012">CBR provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>
<ul id="cbr_04_0017__ul831515201117"><li id="cbr_04_0017__li1431518203113">Permissions: statements in a policy that allow or deny certain operations</li><li id="cbr_04_0017__li1466413303198">APIs: REST APIs that can be called by a user who has been granted specific permissions</li><li id="cbr_04_0017__li123156201611">Actions: specific operations that are allowed or denied</li><li id="cbr_04_0017__li120995613199">Dependencies: actions which a specific action depends on. When allowing an action for a user, you also need to allow any existing action dependencies for that user.</li><li id="cbr_04_0017__li6814564819">IAM projects: the authorization scope of a custom policy</li></ul>
<div class="note" id="cbr_04_0017__note1864518486"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cbr_04_0017__p181245144817">The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.</p>
</div></div>
</li></ul>
<p id="cbr_04_0017__p15518710248">CBR supports the following actions that can be defined in custom policies:</p>
<ul id="cbr_04_0017__ul11753142810920"><li id="cbr_04_0017__li1051817103415">[Example] <a href="cbr_04_0018.html#cbr_04_0018__section16923143918296">Vault</a> includes actions supported by CBR vault APIs, such as APIs for creating, modifying, and deleting a vault, querying the vault list, as well as adding and removing resources.</li><li id="cbr_04_0017__li107531428799">[Example] <a href="cbr_04_0018.html#cbr_04_0018__section86041763166">Backup Sharing</a> includes actions supported by CBR backup sharing APIs, such as APIs for adding share members, obtaining the share member list, and updating the share member status.</li></ul>
<p id="cbr_04_0017__p15518710248">CBR supports the following actions in custom policies:</p>
<ul id="cbr_04_0017__ul11753142810920"><li id="cbr_04_0017__li1051817103415">[Example] Vault actions (<a href="cbr_04_0018.html#cbr_04_0018__section16923143918296">Vault</a>), including all of the actions supported by CBR vault APIs, such as the APIs for creating, modifying, and deleting a vault, querying the vault list, as well as adding and removing resources.</li><li id="cbr_04_0017__li107531428799">[Example] Backup sharing actions (<a href="cbr_04_0018.html#cbr_04_0018__section86041763166">Backup Sharing</a>), including actions supported by CBR backup sharing APIs, such as APIs for adding share members, obtaining the share member list, and updating the share member status.</li></ul>
</div>
</div>
<div>

View File

@ -8,7 +8,13 @@
</th>
</tr>
</thead>
<tbody><tr id="cbr_04_0025__row5554348181510"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_04_0025__p17554114871511">2023-03-21</p>
<tbody><tr id="cbr_04_0025__row18406201893118"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_04_0025__p8406518163117">2023-08-11</p>
</td>
<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.1.1.3.1.2 "><p id="cbr_04_0025__p11536195515317">Updated the following content:</p>
<ul id="cbr_04_0025__ul824814315327"><li id="cbr_04_0025__li82486317324">Modified the maximum number of tags that can be added to a vault.</li></ul>
</td>
</tr>
<tr id="cbr_04_0025__row5554348181510"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.1.1.3.1.1 "><p id="cbr_04_0025__p17554114871511">2023-03-21</p>
</td>
<td class="cellrowborder" valign="top" width="82%" headers="mcps1.3.1.1.3.1.2 "><p id="cbr_04_0025__p987710731614">Updated the following content:</p>
<ul id="cbr_04_0025__ul162575718313"><li id="cbr_04_0025__li225767203113">Modified the issue that response parameters in the table are inconsistent with those in the example response in section "Creating a Vault."</li><li id="cbr_04_0025__li6998121343112">Modified the rules defined by <strong id="cbr_04_0025__b0284338115313">bind_rules</strong> for vault APIs.</li><li id="cbr_04_0025__li4758182873819">Modified parameter restrictions in section "Querying Vault Resources."</li><li id="cbr_04_0025__li169012121394">Modified the vault's minimum capacity in section "Creating a Vault."</li><li id="cbr_04_0025__li13835105017445">Modified the description of <strong id="cbr_04_0025__b18127818185311">api_version</strong> in section "Querying a Specified API Version."</li></ul>

View File

@ -1,7 +1,7 @@
<a name="topic_300000007"></a><a name="topic_300000007"></a>
<a name="topic_300000008"></a><a name="topic_300000008"></a>
<h1 class="topictitle1">Tags</h1>
<div><p> </p>
<div id="body0000001680062637"><p> </p>
</div>
<div>
<ul class="ullinks">