文档中心

云控制API

常见问题

CloudControl API 支持的资源类型有哪些

您可以调用 DescribeResourceType 和 ListResourceTypes 实时获取支持 CloudControl API 的资源类型。以下为部分已支持的资源类型，更新于 2025 年 12 月：

资源类型	Create	Update	Read	Delete	List
Volcengine::ECS::Instance	支持	支持	支持	支持	支持
Volcengine::ECS::Keypair	支持	支持	支持	支持	支持
Volcengine::ECS::Invocation	支持	支持	支持	支持	支持
Volcengine::ECS::Command	支持	支持	支持	支持	支持
Volcengine::ECS::HpcCluster	支持	支持	支持	支持	支持
Volcengine::ECS::Image	支持	支持	支持	支持	支持
Volcengine::AutoScaling::ScalingConfiguration	支持	支持	支持	支持	支持
Volcengine::AutoScaling::ScalingGroup	支持	支持	支持	支持	支持
Volcengine::AutoScaling::ScalingPolicy	支持	支持	支持	支持	支持
Volcengine::CR::Repository	支持	支持	支持	支持	支持
Volcengine::CR::NameSpace	支持	不支持	支持	支持	不支持
Volcengine::CR::Registry	支持	不支持	支持	支持	支持
Volcengine::VKE::Cluster	支持	支持	支持	支持	支持
Volcengine::VKE::Addon	支持	支持	支持	支持	支持
Volcengine::VKE::Permission	支持	支持	支持	支持	支持
Volcengine::VKE::NodePool	支持	支持	支持	支持	支持
Volcengine::VEFAAS::Function	支持	支持	支持	支持	支持
Volcengine::VEFAAS::Sandbox	支持	支持	支持	支持	支持
Volcengine::VEFAAS::KafkaTrigger	支持	支持	支持	支持	不支持
Volcengine::CLB::CLB	支持	支持	支持	支持	支持
Volcengine::CLB::ACL	支持	支持	支持	支持	支持
Volcengine::CLB::Rule	支持	支持	支持	支持	不支持
Volcengine::CLB::NLBServerGroup	支持	支持	支持	支持	支持
Volcengine::CLB::NLBListener	支持	支持	支持	支持	支持
Volcengine::CLB::NLB	支持	支持	支持	支持	支持
Volcengine::CLB::Certificate	支持	支持	支持	支持	支持
Volcengine::CLB::Listener	支持	支持	支持	支持	支持
Volcengine::CLB::ServerGroup	支持	支持	支持	支持	支持
Volcengine::DirectConnect::DirectConnectGateway	支持	支持	支持	支持	支持
Volcengine::CEN::CEN	支持	支持	支持	支持	支持
Volcengine::VPC::EIP	支持	支持	支持	支持	支持
Volcengine::VPC::VPC	支持	支持	支持	支持	支持
Volcengine::VPC::SecurityGroup	支持	支持	支持	支持	支持
Volcengine::VPC::ENI	支持	支持	支持	支持	支持
Volcengine::VPC::Subnet	支持	支持	支持	支持	支持
Volcengine::VPC::PrefixList	支持	支持	支持	支持	支持
Volcengine::VPC::RouteTable	支持	支持	支持	支持	支持
Volcengine::VPC::NetworkAcl	支持	支持	支持	支持	不支持
Volcengine::VPC::BandwidthPackage	支持	支持	支持	支持	支持
Volcengine::TransitRouter::TransitRouter	支持	支持	支持	支持	支持
Volcengine::TransitRouter::TransitRouterRouteTable	支持	支持	支持	支持	不支持
Volcengine::TransitRouter::TransitRouterRouteEntry	支持	支持	支持	支持	不支持
Volcengine::ALB::ACL	支持	支持	支持	支持	支持
Volcengine::ALB::Certificate	支持	支持	支持	支持	支持
Volcengine::ALB::ServerGroup	支持	支持	支持	支持	支持
Volcengine::ALB::Listener	支持	支持	支持	支持	支持
Volcengine::ALB::LoadBalancer	支持	支持	支持	支持	支持
Volcengine::MongoDB::Instance	支持	支持	支持	支持	支持
Volcengine::RDSMySQL::Instance	支持	支持	支持	支持	支持
Volcengine::RDSMySQL::DBAccount	支持	支持	支持	支持	支持
Volcengine::RDSMySQL::Database	支持	支持	支持	支持	不支持
Volcengine::Redis::Instance	支持	支持	支持	支持	支持
Volcengine::RDSPostgreSQL::Instance	支持	支持	支持	支持	支持
Volcengine::VEDBM::Instance	支持	支持	支持	支持	支持
Volcengine::TOS::Bucket	支持	支持	支持	支持	支持
Volcengine::VEPFS::Instance	支持	支持	支持	支持	支持
Volcengine::StorageEBS::Volume	支持	支持	支持	支持	支持
Volcengine::StorageEBS::Snapshot	支持	支持	支持	支持	支持
Volcengine::TLS::Topic	支持	支持	支持	支持	支持
Volcengine::Kafka::Instance	支持	支持	支持	支持	支持
Volcengine::Kafka::Topic	支持	支持	支持	支持	支持
Volcengine::CDN::ShareConfig	支持	支持	支持	支持	支持
Volcengine::PrivateZone::ResolverEndpoint	支持	支持	支持	支持	支持
Volcengine::PrivateZone::ResolverRule	支持	支持	支持	支持	支持
Volcengine::IAM::Group	支持	支持	支持	支持	支持
Volcengine::IAM::Policy	支持	支持	支持	支持	支持
Volcengine::IAM::Role	支持	支持	支持	支持	支持
Volcengine::IAM::User	支持	支持	支持	支持	支持
Volcengine::IAM::Accesskey	支持	支持	支持	支持	支持
Volcengine::Organization::Account	支持	支持	支持	支持	支持
Volcengine::Organization::Unit	支持	支持	支持	支持	支持
Volcengine::CloudIdentity::User	支持	支持	支持	支持	支持
Volcengine::ARK::Endpoint	支持	不支持	支持	支持	支持
Volcengine::WAF::Domain	支持	支持	支持	支持	支持
Volcengine::FileNAS::Instance	支持	支持	支持	支持	支持
Volcengine::VMP::Workspace	支持	支持	支持	支持	支持
Volcengine::RabbitMQ::Instance	支持	支持	支持	支持	支持
Volcengine::ESCloud::Instance	支持	支持	支持	支持	支持
Volcengine::KMS::Key	支持	支持	支持	支持	支持
Volcengine::BMQ::Instance	支持	支持	支持	支持	支持
Volcengine::APIG::Gateway	支持	支持	支持	支持	支持
Volcengine::APIG::CustomDomain	支持	支持	支持	支持	支持
Volcengine::APIG::Route	支持	支持	支持	支持	支持
Volcengine::APIG::Upstream	支持	支持	支持	支持	支持
Volcengine::APIG::UpstreamSource	支持	支持	支持	支持	支持
Volcengine::APIG::GatewayService	支持	支持	支持	支持	支持
Volcengine::NatGateway::NGW	支持	支持	支持	支持	支持
Volcengine::NatGateway::Snatentry	支持	支持	支持	支持	支持
Volcengine::NatGateway::Dnatentry	支持	支持	支持	支持	支持
Volcengine::NatGateway::NatIp	支持	支持	支持	支持	支持
Volcengine::PrivateLink::EndpointService	支持	支持	支持	支持	支持
Volcengine::HBase::Instance	支持	支持	支持	支持	支持
Volcengine::RocketMQ::Instance	支持	支持	支持	支持	支持
Volcengine::CBR::BackupResource	支持	支持	支持	支持	支持
Volcengine::CBR::BackupPolicy	支持	支持	支持	支持	支持
Volcengine::CBR::BackupPlan	支持	支持	支持	支持	支持
Volcengine::RDSMsSQL::Instance	支持	支持	支持	支持	支持
Volcengine::FireWallCenter::DnsControlPolicy	支持	支持	支持	支持	支持

CloudControl API 支持的地域有哪些

地域名称	地域 ID
华东 2（上海）	cn-shanghai
华北 2（北京）	cn-beijing
华南 1（广州）	cn-guangzhou
亚太东南（柔佛）	ap-southeast-1
华北 4（大同）	cn-datong
华北 3（北京）	cn-beijing2
中国香港	cn-hongkong
亚太东南（新加坡）	ap-southeast-2
亚太东南（雅加达）	ap-southeast-3
华北 5（乌兰察布）	cn-wulanchabu
西南（成都）	cn-chengdu
华东（杭州）	cn-hangzhou
华中（武汉）	cn-wuhan
华北2（北京）自动驾驶云	cn-beijing-selfdrive
华北2（北京）自动驾驶云2	cn-beijing-autodriving
华东2（上海）自动驾驶云1	cn-shanghai-autodriving
华北300（北京）	cn-beijing300

注意，CloudControl API 支持的地域不等同于云产品支持的地域，在用 CloudControl API 操作云产品资源时，请关注对应云产品支持的地域情况。

如何查看可以操作的资源属性

调用 DescribeResourceType 查看指定资源类型的元数据

在返回结果的 Schema 结构体下的 “properties” 中查看资源类型对应的属性字段

属性约束字段的定义详见资源元数据结构

如何确定资源的Identifier

Identifier 是 CCAPI 用于标识资源的唯一标识符，对指定资源进行变更操作时，需要显式提供 Identifier 信息。您可以通过以下方式获取 Identifier。

通过 DescribeResourceType 接口获取资源元数据，搜索 primaryIdentifier 字段，如下 /properties/ 后的 InstanceId 即为 Identifier 的属性。

存在层级关系的资源其 Identifier 可以多个资源属性组成，对应查询到的 primaryIdentifier 下有多个 property，此时的 Identifier 需要按序拼接，中间用 "|" 符号分割，如下 Volcengine::TransitRouter::TransitRouterRouteTable 的 Identifer 为 TransitRouterId|TransitRouterRouteTableId。

若需要获取具体资源的 Identifier ，可以通过 ListResources 接口获取

注意，尽管大多数场景下 Identifier 和 ResourceId/ResourceName 一致，但是两者并不完全等价，Identifier 是唯一定位资源的标识符，ResourceId/ResourceName 属于资源的通用属性。在一些场景下 ResourceId/ResourceName 无法定位一个资源，如路由表、IAM策略等资源需要提供额外的层级/类别信息，此时两者信息不一致。CCAPI 的更新、删除、查询均是围绕 Identifier 进行的。

如何填写资源更新所需的 PatchDocument

调用 DescribeResourceType 查看指定的资源类型元数据，关注哪些是可以更新的数据，readOnlyProperties、writeOnlyProperties、createOnlyProperties 标识的属性是不允许进行更新操作。

明确资源所要更新的属性及值，以符合 RFC 6902 - JavaScript Object Notation （JSON） Patch 的格式表达。

其中每段 Patch 定义了对特定资源属性的操作，通常包含三个要素：

op：操作类型，必填，如 add、remove、replace 等；

操作类型	说明	示例
add	向指定路径添加新值若目标路径为对象属性：直接添加新字段，若字段已存在则覆盖若目标路径为数组：根据索引插入或追加元素	// 示例1：添加对象属性 [ { "op": "add", "path": "/address", "value": "Beijing" } ] /* 原数据：{ "name": "Alice" } → 结果：{ "name": "Alice", "address": "Beijing" } /// 示例2：向数组插入元素 [ { "op": "add", "path": "/list/1", "value": "mid" } ] / 原数据：{ "list": ["a", "c"] } → 结果：{ "list": ["a", "mid", "c"] } */
remove	删除指定路径的现有值，路径必须存在，否则报错	// 示例：删除对象属性 [ { "op": "remove", "path": "/oldKey" } ] /* 原数据：{ "oldKey": 123 } → 结果：{} */
replace	替换路径处的现有值（路径必须存在）。等同于先remove再add	// 示例：替换字段值 [ { "op": "replace", "path": "/age", "value": 30 } ] /* 原数据：{ "age": 25 } → 结果：{ "age": 30 } */
move	将值从from路径移动至path路径。逻辑为先removea路径值，再add到b路径	// 示例：移动属性 [ { "op": "move", "from": "/firstName", "path": "/name" } ] /* 原数据：{ "firstName": "Bob" } → 结果：{ "name": "Bob" } */
copy	将from路径值复制到path路径，保留原值	// 示例：复制数组元素 [ { "op": "copy", "from": "/users/0", "path": "/users/-" } ] /* 原数据：{ "users": ["Alice"] } → 结果：{ "users": ["Alice", "Alice"] } */
test	校验path处的值是否等于指定值。失败则终止整个Patch的Update操作。	// 示例：验证数值 [ { "op": "test", "path": "/count", "value": 100 } ] /* 原数据若为 { "count": 100 } → 测试通过，继续后续操作；若不一致则整个Patch失败 */

path：资源属性路径，以斜杠/开头，采用类似文件系统的分层语法，必填。可以通过 GetResource 获取指定资源的Properties，也可以通过 DescribeResourceType 查看属性元数据；

value：需要更新的属性值，非必填，remove、move、copy 时无需传入值。

如下示例是对 IAM 子用户进行的更新操作示例

什么是同步操作和异步操作

同步操作与异步操作是程序处理任务执行的两种模式，同步操作在任务执行完成后才返回，而异步操作则不等待任务执行完成即返回。在处理资源查询、资源列表、元数据查询、任务查询等任务时，CloudControl API 采用同步操作；而在处理资源创建、删除、更新等任务，因为处理任务的用时较长，所以 CloudControl API 采用异步处理，以提高接口执行的稳定性。对于异步操作，会在返回结果中展示“OperationStatus”和“TaskID”，用户可以通过 ListTasks 列举所有异步任务，也可以通过 GetTask 查询指定异步操作的完成情况。

最近更新时间：2025.12.25 21:20:09

这个页面对您有帮助吗？

有用

无用