Updated on 2025-11-07 GMT+08:00

Obtaining Resource Information

Function

Obtain resource information.

URI

POST /v2.0/servicerequest/diagnose/job/vm/resources

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Specifies the project ID.

Minimum length: 0

Maximum length: 128

region

No

String

Specifies the region.

Minimum length: 1

Maximum length: 128

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total_count

Integer

Specifies the total number.

Minimum value: 0

Maximum value: 65535

result

Array of DiagnoseResourceVo objects

Specifies the list of diagnosis records.

Array length: 0 - 65535

Table 4 DiagnoseResourceVo

Parameter

Type

Description

fault

String

Describes the fault.

Minimum length: 0

Maximum length: 64

id

String

Specifies the resource ID.

Minimum length: 0

Maximum length: 64

name

String

Specifies the resource name.

Minimum length: 0

Maximum length: 64

accessIPv4

String

Specifies the IPv4 address.

Minimum length: 0

Maximum length: 64

accessIPv6

String

Specifies the IPv6 address.

Minimum length: 0

Maximum length: 64

status

String

Specifies the status.

Minimum length: 0

Maximum length: 64

progress

String

Specifies the progress.

Minimum length: 0

Maximum length: 64

tenantId

String

Specifies the front-end ID.

Minimum length: 0

Maximum length: 64

userId

String

Specifies the user ID.

Minimum length: 0

Maximum length: 64

metadata

Object

Specifies the resource metadata.

Minimum length: 0

Maximum length: 64

hostId

String

Specifies the host ID.

Minimum length: 0

Maximum length: 64

Request Example

POST https://{endpoint}/v2.0/servicerequest/diagnose/job/vm/resources

{
  "project_id" : "projectId",
  "region" : "cn-north-7"
}

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "total_count" : 0,
  "result" : null
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.