文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API(v3版本)/ 环境/ 获取环境可纳管的资源 - ShowEnvironmentResources
更新时间:2025-11-20 GMT+08:00
分享

获取环境可纳管的资源 - ShowEnvironmentResources

功能介绍

此API用于根据类型获取环境可纳管的资源。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    servicestage:environment:list

    list

    -

    -

    servicestage:app:list

    -

URI

GET /v3/{project_id}/cas/environments/resources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID。获取方法,请参考获取项目ID

environment_id

String

环境ID。获取方法,请参考获取所有环境 - ObtainAllEnvironments

表2 查询参数

参数

是否必选

参数类型

描述

resource_type

String

资源类型。

  • eip,弹性IP。
  • elb,弹性负载均衡。
  • cce,云容器引擎。
  • ecs,弹性云服务器。
  • dcs,分布式缓存服务。
  • rds,云数据库。
  • cse,ServiceComb引擎。
  • nacos,注册配置中心。
  • ms_gateway,应用网关。

    “华东-上海一”“亚太-新加坡”区域支持纳管应用网关,用于使用全链路流量控制功能。

  • subnet,子网。
  • acl,网络ACL。
  • gaussdb,云数据库GaussDB。
  • dms_rocketmq,分布式消息服务RocketMQ。
  • css_es,云搜索服务Elasticsearch。
  • custom_k8s,自定义kubernetes集群。

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),默认取值为“application/json;charset=utf8”。

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权

响应消息

表4 响应参数

参数

参数类型

描述

resources

Array of objects

资源,请参考表5

表5 schemas

参数

参数类型

描述

id

String

资源ID。

name

String

资源名称。

type

String

资源类型。

  • eip,弹性IP。
  • elb,弹性负载均衡。
  • cce,云容器引擎。
  • ecs,弹性云服务器。
  • dcs,分布式缓存服务。
  • rds,云数据库。
  • cse,ServiceComb引擎。
  • nacos,注册配置中心。
  • ms_gateway,应用网关。

    “华东-上海一”“亚太-新加坡”区域支持纳管应用网关,用于使用全链路流量控制功能。

  • subnet,子网。
  • acl,网络ACL。
  • gaussdb,云数据库GaussDB。
  • dms_rocketmq,分布式消息服务RocketMQ。
  • css_es,云搜索服务Elasticsearch。
  • custom_k8s,自定义kubernetes集群。

environment_id

String

环境ID。

environment_name

String

环境名称。

请求示例

响应示例

{
    "resources": [
        {
            "id": "34318058-8e0e-11f0-8a33-0255ac1380a0",
            "type": "cce",
            "environment_id": "9c2a8c14-bdca-4b77-ad79-0849d754c26c",
            "environment_name": "test-1105"
        }
    ]
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

请参考ServiceStage错误码

相关文档