El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Cloud Data Center
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Domain Name Service
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
DataArts Fabric
Cloud Transformation
Well-Architected Framework
Cloud Adoption Framework
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Blockchain
Blockchain Service
Web3 Node Engine Service
MacroVerse aPaaS
CloudDevice
KooDrive
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance (CCI)
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Meeting
IoT
IoT Device Access
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Industry Video Management Service
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
Huawei Cloud Astro Canvas
Huawei Cloud Astro Zero
CodeArts Governance
Help Center/ Cloud Eye/ API Reference/ API V2/ Resource Groups/ Querying Details of a Resource Group

Querying Details of a Resource Group

Function

This API is used to query details of 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

GET /v2/{project_id}/resource-groups/{group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant ID.

group_id

Yes

String

Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

group_name

String

Resource group name.

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)$

group_id

String

Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.

create_time

String

Time when a resource group was created.

enterprise_project_id

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

String

Resource adding/matching mode. The value can only be EPS (matching enterprise projects), TAG (matching tags), NAME (matching instance names), COMB (combination matching), or Manual (manual adding).

Enumeration values:

  • EPS

  • TAG

  • NAME

  • COMB

  • Manual

association_ep_ids

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.

tags

Array of ResourceGroupTagRelation objects

Specified tag rule when the resource matching rule is tag matching.

instances

Array of Instance objects

Parameter transferred for matching resources by instance name.

comb_relation

CombRelation object

Matching resources by multiple criteria.

related_ep_ids

Array of strings

List of specified enterprise projects when the resource matching rule is enterprise project matching.

enterprise_project_id_and_tags

Array of EnterpriseProjectIdAndTags objects

Parameter for matching resources by enterprise project or tag.

status

String

Metric alarm status. The value can be health (alarming), unhealthy (triggered), or no_alarm_rule (no alarm rule is set).

Enumeration values:

  • health

  • unhealthy

  • no_alarm_rule

event_status

String

Event alarm status. The value can be health (alarming), unhealthy (triggered), or no_alarm_rule (no alarm rule is set).

Enumeration values:

  • health

  • unhealthy

  • no_alarm_rule

resource_statistics

resource_statistics object

Resource quantity statistics.

resource_level

String

dimension indicates the sub-dimension, and product indicates the cloud product.

Enumeration values:

  • dimension

  • product

product_names

String

Value of a cloud product when the resource level is cloud product. Generally, the value consists of the service namespace and the first-level dimension name of the service, for example, SYS.ECS,instance_id. Use semicolons (;) to separate multiple cloud products, for example, "SERVICE.BMS,instance_id;SYS.ECS,instance_id".

ep_resource_statistics

Array of EpResourceStatistics objects

Status of resources associated with each enterprise project

Table 4 ResourceGroupTagRelation

Parameter

Type

Description

key

String

TMS tag key specifications.

operator

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:

  • include

  • prefix

  • suffix

  • notInclude

  • equal

  • all

value

String

TMS tag value specifications.

Table 5 Instance

Parameter

Type

Description

product_name

String

Cloud product name.

logical_operator

String

Logical operator.

ALL: All conditions are matched.

ANY: Any condition is matched.

Enumeration values:

  • ALL

  • ANY

instance_names

Array of ResourceName objects

Parameter array for matching resources by resource name.

Table 6 ResourceName

Parameter

Type

Description

resource_name

String

Resource name condition value.

operator

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:

  • include

  • prefix

  • suffix

  • notInclude

  • equal

  • all

resource_name_is_ignore_case

Boolean

The resource name is case-insensitive.

Table 7 CombRelation

Parameter

Type

Description

logical_operator

String

Logical operator.

ALL: All conditions are matched.

ANY: Any condition is matched.

Enumeration values:

  • ALL

  • ANY

conditions

Array of Condition objects

Combined matching conditions for resource groups.

Table 8 Condition

Parameter

Type

Description

enterprise_project_id

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

ResourceName object

Resource name.

tag

ResourceGroupTagRelation object

Tag matching rule.

Table 9 EnterpriseProjectIdAndTags

Parameter

Type

Description

enterprise_project_id

String

Enterprise Project ID.

Regex Pattern: ^([a-z]|[A-Z]|[0-9]|_|-)+$

tag

ResourceGroupTagRelation object

Tag matching rule.

Table 10 resource_statistics

Parameter

Type

Description

unhealthy

Integer

Number of resources in the alarm

Value range:

0-9999999

total

Integer

Total number of resources.

Value range:

0-9999999

event_unhealthy

Integer

Number of triggered resources

Value range:

0-9999999

namespaces

Integer

Resource Types

Value range:

0-9999999

Table 11 EpResourceStatistics

Parameter

Type

Description

extend_relation_id

String

Enterprise project ID

unhealthy

Integer

Number of resources in the alarm

Value range:

0-9999999

total

Integer

Total number of resources.

Value range:

0-9999999

event_unhealthy

Integer

Number of triggered resources

Value range:

0-9999999

namespaces

Integer

Resource Types

Value range:

0-9999999

Status code: 400

Table 12 Response body parameters

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

Table 13 Response body parameters

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

Table 14 Response body parameters

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: 404

Table 15 Response body parameters

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

Table 16 Response body parameters

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

Query details of a resource group.

/v2/{project_id}/resource-groups/{group_id}

Example Responses

Status code: 200

OK

{
  "group_name" : "band",
  "type" : "TAG",
  "tags" : [ {
    "key" : "Resource",
    "value" : "VPC"
  }, {
    "key" : "Usage",
    "value" : "Tmp"
  } ],
  "create_time" : "2006-01-02T15:04:05.000Z",
  "group_id" : "rg0123456789xxxx",
  "enterprise_project_id" : "0"
}

Status Codes

Status Code

Description

200

OK

400

Parameter verification failed.

401

Not authenticated.

403

Authentication failed.

404

Resource not found.

500

Internal system error.

Error Codes

See Error Codes.

Utilizamos cookies para mejorar nuestro sitio y tu experiencia. Al continuar navegando en nuestro sitio, tú aceptas nuestra política de cookies. Descubre más

Feedback
咨询盘古Doer

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback