本文将为您介绍云控制API涉及到的基本概念。
资源元数据
资源元数据描述了资源的属性、类型、关系和行为等信息,所有的资源管理都是基于资源元数据的操作。文章GetResourceType能够帮助您获取指定资源的元数据,解读返回参数中的元数据。
元数据信息可分为三个部分:资源基本信息、资源属性及扩展信息。
资源基本信息:主要包括资源名称、所属产品、描述、部署级别、付费类型等字段。
资源属性:包括资源的具体属性描述、操作私有参数集合与敏感属性集合等。
拓展信息:主要包括鉴权信息(资源操作授权策略)和资源容量等信息(流控&配额)。
父资源与子资源
父资源与子资源是逻辑概念,用于描述同一产品所拥有资源之间的依赖关系,父资源包含子资源,子资源从属于父资源。明确资源间的逻辑关系,有助于子资源的资源管理。
如何判断资源是否有父资源
如果资源元数据中resourceType格式为“****/****”,说明该资源存在父资源。例如产品云数据库Redis,拥有资源Redis实例(DBInstance)和数据库账号(DBInstance/Account),其中数据库账号的resourceType为”DBInstance/Account“,说明数据库账号存在父资源,父资源的resourceType为DBInstance,即Redis实例。
资源存在父资源,如何进行资源管理
调用API进行资源管理操作时,如果资源存在父资源,需要在请求路径中添加父资源信息,详情请参见API目录中具体API请求参数的requestPath。
同步操作与异步操作
同步操作与异步操作是程序处理任务执行的两种模式,区别在于,同步操作在任务执行完成后才返回,而异步操作则不等待任务执行完成就返回。
一般情况下,云控制API采用同步操作,如处理资源的查询、列举或更新以及元数据查询等任务;资源的创建与删除任务,因为处理任务的用时可能较长,所以云控制API采用异步处理,提高处理的稳定性。
云控制API如果采用异步操作,返回码statusCode为“202”,您可以通过GetTask查询异步操作的任务状态。
- 本页导读 (1)
- 资源元数据
- 父资源与子资源
- 同步操作与异步操作