查询资源详细属性信息 ## 调试 [去调试](https://api.volcengine.com/api-explorer/?action=GetResourceDescription&groupName=%E8%B5%84%E6%BA%90%E6%90%9C%E7%B4%A2&serviceCode=resourcecenter&version=2023-06-01) ## 请求参数下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6369/67268)。 **Action** string 必选 `示例值：GetResourceDescription` 要执行的操作，取值：GetResourceDescription。 **Version** string 必选 `示例值：2023-06-01` API的版本，取值：2023\-06\-01。 **Region** string `可选` `示例值：cn-beijing` 地域 **TypeName** string 必选 `示例值：Volcengine::ECS::Instance` 资源类型名称 **Identifier** string 必选 `示例值：i-3tdasfqervsi9` 资源标识 ## 返回参数下方仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6369/80336)。 **Service** string `示例值：ecs` 服务名 **ResourceType** string `示例值：instance` 资源类型 **TypeName** string `示例值：Volcengine::ECS::Instance` 资源类型名称 **Region** string `示例值：cn-beijing` 地域 **AccountID** long `示例值：2100000000` 账号ID **Identifier** string `示例值：i-3tdasfqervsi9` 资源唯一标识符 **ResourceID** string `示例值：i-3tdasfqervsi9` 资源ID **ResourceName** string `示例值：n-3tdasfqervsi9` 资源名称 **ProjectName** string `示例值：default` 项目名称 **Tags** object[] `示例值：_` 标签 **Key** string `示例值：k1` 标签键 **Value** string `示例值：v1` 标签值 **CreateTime** string `示例值：2023-09-14T18:41:44Z` 创建时间 **PrivateIpAddress** string[] `示例值：["192.168.1.2"]` 私网IP **PublicIpAddress** string[] `示例值：["203.12.xxx.xxx"]` 公网IP **ResourceDescription** object `示例值：_` 资源详细属性信息，具体字段随资源类型变化。 ## 请求示例 ```text POST /?Action=GetResourceDescription&Version=2023-06-01 HTTP/1.1 Host: resourcecenter.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20260918T055933Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260918/cn-beijing/resourcecenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "Region": "cn-beijing", "TypeName": "Volcengine::ECS::Instance", "Identifier": "i-3tdasfqervsi9" } ``` ## 返回示例 ```text { "ResponseMetadata": { "RequestId": "202609181359390730921701958B3D18", "Action": "GetResourceDescription", "Version": "2023-06-01", "Service": "resourcecenter", "Region": "cn-beijing" }, "Result": { "Service": "ecs", "ResourceType": "instance", "TypeName": "Volcengine::ECS::Instance", "Region": "cn-beijing", "AccountID": 2100000000, "Identifier": "i-3tdasfqervsi9", "ResourceID": "i-3tdasfqervsi9", "ResourceName": "n-3tdasfqervsi9", "ProjectName": "default", "Tags": [ { "Key": "k1", "Value": "v2" } ], "CreateTime": "2023-09-14T18:41:44Z", "PrivateIpAddress": [ "192.168.xxx.xxx" ], "PublicIpAddress": [ "203.12.xxx.xxx" ], "ResourceDescription": { "InstanceId": "i-yevaxxxxxxxxxxx", "InstanceName": "testtttttt", "InstanceType": "ecs.g3a.8xlarge", "CreatedAt": "2023-09-14T18:41:44Z" } } } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。 |状态码 |错误码 |错误信息 |说明 | |---|---|---|---| |400 |InvalidParameter |The specified parameter %s is invalid. |请求参数错误 | |400 |InvalidParameter.Identifier |The specified parameter Identifier is invalid. |请求参数 Identifier 不合法 | |400 |InvalidParameter.TypeName |The specified parameter TypeName is invalid. |请求参数 TypeName 不合法 | |400 |ResourceTypeNotEnabled |The resource type is not enabled. |该资源类型暂不支持。 | |400 |ServiceNotEnabled |ResourceCenter Service is not enabled. |资源中心服务暂未开通 | |404 |ResourceNotFound |The resource is not found. |该资源不存在。 | |500 |InternalError |The request has failed due to an unknown error. |内部服务错误，请稍后重试 |

资源管理