Updated on 2025-09-25 GMT+08:00

Obtaining Resource Details

Function

This API is used to obtain resource details based on the project ID.

URI

POST /v1/{project_id}/ss-service/resources/detail

Table 1 describes the parameters.

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

is_filter

Yes

bool

Whether to filter. Value: true or false.

resources

No

Array of Object

Resource information to be obtained.

Table 4 resources parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Resource type, for example, vpc or elb.

ids

No

Array of String

Resource information to be obtained.

[

"081c539d-ed09-43b0-81d7-a87603e528b7"

]

Response

Table 5 Response

Parameter

Type

Description

vpc

Object

Returned information. See Table 6.

Table 6 VPC parameter

Parameter

Type

Description

vpcs

Object

Returned information. See Table 7.

Table 7 Detailed vpc parameters

Parameter

Type

Description

id

String

Resource ID.

name

String

Resource name.

description

String

Resource description.

cidr

String

CIDR information.

status

String

Resource status. OK: normal. FAILED: abnormal.

Example Request

None

Example Response

None

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

The error code format is SVCSTG.SS.[Error_ID], for example, SVCSTG.SS.5004401. For details, see ServiceStage Error Codes.