Esta página ainda não está disponível no idioma selecionado. Estamos trabalhando para adicionar mais opções de idiomas. Agradecemos sua compreensão.
Creating a Resource Group (Recommended)
Function
This API is used to create a resource group.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v2/{project_id}/resource-groups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Tenant token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_name |
Yes |
String |
Resource group name. The value can contain up to 128 characters, including letters, digits, hyphens (-), and underscores (_). Regex Pattern: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ |
enterprise_project_id |
No |
String |
ID of the enterprise project that a resource group belongs to. Regex Pattern: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ |
type |
No |
String |
Method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects), TAG (dynamic tag matching), or NAME (instance name). If this parameter is not specified, resources are manually added. Regex Pattern: ^(EPS|TAG|Manual|COMB|NAME)$ |
tags |
No |
Array of ResourceGroupTagRelation objects |
Associated tag during dynamic tag matching. This parameter is mandatory when type is set to TAG. |
association_ep_ids |
No |
Array of strings |
ID of the enterprise project from which resources in the resource group come. This parameter is mandatory when type is set to EPS. |
providers |
No |
String |
Cloud service name, in the format of dcs,ecs. For details about supported cloud service providers, see https://support.huaweicloud.com/api-rms/rms_06_0100.html. |
enterprise_project_id_and_tags |
No |
Array of EnterpriseProjectIdAndTags objects |
Parameter for matching resources by enterprise project or tag. |
resources |
No |
Array of Resource objects |
Resource details when resources are manually added. |
product_resources |
No |
Array of ProductResource objects |
Resource details when the resource level is cloud product and resources are manually added. |
instances |
No |
Array of Instance objects |
Parameter transferred for matching resources by instance name. |
product_names |
No |
String |
Name of a cloud product when the resource level is cloud product. Generally, the value format is Service namespace,First-level dimension of the service, for example, SYS.ECS,instance_id. Multiple cloud products are separated by semicolons (;), for example, SERVICE.BMS,instance_id;SYS.ECS,instance_id. |
resource_level |
No |
String |
Resource level, which indicates the resource scope. If you select Cloud product for Resource Level, resources from the selected cloud product and its dimensions will be added to the resource group. If you select Specific dimension for Resource Level, only resources from the specific sub-dimension will be added. product: cloud product dimension: sub-dimension Enumeration values:
|
comb_relation |
No |
CombRelation object |
Matching resources by multiple criteria. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
TMS tag key specifications. |
operator |
No |
String |
Tag operator, which indicates the relationship between the tag key and value. include: indicates include. prefix: indicates the prefix. suffix: indicates the suffix. notInclude: indicates not included. equal: indicates equal. If operator is equal and value is an empty string, all tag values of the key are matched. all: indicates all. Enumeration values:
|
value |
No |
String |
TMS tag value specifications. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise Project ID. Regex Pattern: ^([a-z]|[A-Z]|[0-9]|_|-)+$ |
tag |
No |
ResourceGroupTagRelation object |
Tag matching rule. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
namespace |
Yes |
String |
Namespace of a service. For details about the namespace of each service, see Namespace. |
dimensions |
Yes |
Array of ResourceDimension objects |
Resource dimension information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service metric dimension. Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ |
value |
Yes |
String |
Value of a resource dimension. It is the instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Regex Pattern: ^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$ |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
product_name |
Yes |
String |
Cloud product that the resource belongs to. Generally, the value format is Service namespace,First-level dimension name of the service, for example, SYS.ECS,instance_id. |
namespace |
Yes |
String |
Namespace of a service. For details about the namespace of each service, see Namespace. Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ |
product_instances |
Yes |
Array of ProductInstance objects |
Product instance details. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
first_dimension_name |
Yes |
String |
First-level dimension of the resource. For example, the dimension of an ECS is instance_id. Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ |
first_dimension_value |
Yes |
String |
First-level dimension value of the resource, which is the resource ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Regex Pattern: ^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$ |
resource_name |
Yes |
String |
Resource name. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
product_name |
Yes |
String |
Cloud product name. |
logical_operator |
Yes |
String |
Logical operator. ALL: All conditions are matched. ANY: Any condition is matched. Enumeration values:
|
instance_names |
Yes |
Array of ResourceName objects |
Parameter array for matching resources by resource name. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
resource_name |
No |
String |
Resource name condition value. |
operator |
Yes |
String |
Instance operator, which indicates the operation relationship between the actual resource name and the resource name condition value. include: indicates include. prefix: indicates the prefix. suffix: indicates the suffix. notInclude: indicates not included. equal: indicates equal. all: indicates all. Enumeration values:
|
resource_name_is_ignore_case |
No |
Boolean |
The resource name is case-insensitive. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
logical_operator |
Yes |
String |
Logical operator. ALL: All conditions are matched. ANY: Any condition is matched. Enumeration values:
|
conditions |
Yes |
Array of Condition objects |
Combined matching conditions for resource groups. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise Project ID. Regex Pattern: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ |
instance_name |
No |
ResourceName object |
Resource name. |
tag |
No |
ResourceGroupTagRelation object |
Tag matching rule. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
group_id |
String |
Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Status codes customized by each cloud service when a request error occurs. |
error_msg |
String |
Request error message. |
request_id |
String |
Request ID. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Status codes customized by each cloud service when a request error occurs. |
error_msg |
String |
Request error message. |
request_id |
String |
Request ID. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Status codes customized by each cloud service when a request error occurs. |
error_msg |
String |
Request error message. |
request_id |
String |
Request ID. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Status codes customized by each cloud service when a request error occurs. |
error_msg |
String |
Request error message. |
request_id |
String |
Request ID. |
Example Requests
Creating a resource group whose group _name is rg_test and type is TAG.
{
"group_name" : "rg_test",
"enterprise_project_id" : "0",
"type" : "TAG",
"tags" : [ {
"key" : "key1",
"value" : "value1"
} ],
"association_ep_ids" : [ "d61d4705-5658-42f5-8e0c-70eb34d17b02" ]
}
Example Responses
Status code: 200
Created
{
"group_id" : "rg0123456789xxx"
}
Status Codes
Status Code |
Description |
---|---|
200 |
Created |
400 |
Parameter verification failed. |
401 |
Not authenticated. |
403 |
Authentication failed. |
500 |
Internal system error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot