云服务器内容精选

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of TagDTO objects 一个或多个标签键值对的列表。标签键必须存在,而不是空字符串。标签值必须存在,但可以是空字符串。 page_info PageInfoMarkerByKey object 分页详细信息。 表4 TagDTO 参数 参数类型 描述 key String 标签"键"的标识符或名称。您可以将标签的值设置为空字符串,但不能设置为null。 values Array of strings 值列表。每个值最大长度255个字符。 表5 PageInfoMarkerByKey 参数 参数类型 描述 previous_marker String 上一页的页面标识。 next_marker String 下一页的页面标识。 current_count Integer 页面数量。
  • 响应示例 状态码: 200 请求成功。 { "tags" : [ { "key" : "string", "values" : [ "string" ] } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 } }
  • 响应示例 状态码: 200 请求成功。 { "resource_shares" : [ { "id" : "string", "name" : "string", "description" : "string", "allow_external_principals" : true, "owning_account_id" : "string", "status" : "string", "tags" : [ { "key" : "string", "value" : "string" } ], "created_at" : "2023-01-06T08:24:55.638Z", "updated_at" : "2023-01-06T08:24:55.638Z" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 resource_shares Array of ResourceShare objects 资源共享实例的详细信息列表。 page_info PageInfo object 分页详细信息。 表5 ResourceShare 参数 参数类型 描述 id String 资源共享实例的ID。 name String 资源共享实例的名称。 description String 资源共享实例的描述。 allow_external_principals Boolean 资源共享实例是否支持共享给组织外账号。 owning_account_id String 资源共享实例的所有者ID。 status String 资源共享实例的状态。 tags Array of Tag objects 资源共享实例的标签列表。 created_at String 创建资源共享实例的时间。 updated_at String 最后一次更新资源共享实例的时间。 表6 Tag 参数 参数类型 描述 key String 标签"键"的标识符或名称。 value String 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。 表7 PageInfo 参数 参数类型 描述 previous_marker String 上一页的页面标识。 next_marker String 下一页的页面标识。 current_count Integer 页面数量。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 表2 请求Body参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页页面的最大值。 name 否 String 资源共享实例名称。 marker 否 String 页面标记。 permission_id 否 String 权限ID。 resource_owner 是 String 检索您创建的或共享给您的(self或者other-accounts)资源共享实例。 resource_share_ids 否 Array of strings 资源共享实例的ID列表。 resource_share_status 否 String 资源共享实例的状态。 tag_filters 否 Array of TagFilter objects 资源共享实例的标签。 表3 TagFilter 参数 是否必选 参数类型 描述 key 是 String 标签"键"的标识符或名称。 values 否 Array of strings 标签"键"对应的"值"列表。
  • 请求示例 检索您创建的资源共享实例详情。 POST https://{endpoint}/v1/resource-shares/search { "limit" : 2000, "name" : "string", "marker" : "string", "permission_id" : "string", "resource_owner" : "self", "resource_share_ids" : [ "string" ], "resource_share_status" : "string", "tag_filters" : [ { "key" : "string", "values" : [ "string" ] } ] }
  • 修订记录 发布日期 修订记录 2024-03-15 第七次正式发布。 资源访问管理 (Resource Access Manager,简称 RAM )正式商用。 2023-12-30 第六次正式发布。 新增“获取权限的所有版本”接口。 2023-08-30 第五次正式发布。 新增“检索云服务资源类型”接口。 2023-05-30 第四次正式发布。 新增“查询资源共享的配额”接口。 2023-04-11 第三次正式发布。 新增“标签管理”相关接口。 2023-03-20 第二次正式发布。 新增部分错误码。 2022-10-29 第一次正式发布。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of Tag objects 一个或多个标签键值对的列表。标签键必须存在,而不是空字符串。标签值必须存在,但可以是空字符串。 表4 Tag 参数 是否必选 参数类型 描述 key 是 String 标签"键"的标识符或名称。 value 是 String 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。
  • 响应示例 状态码: 200 请求成功。 { "resource_types" : [ { "region_id" : "string", "resource_type" : "string" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 resource_types Array of ResourceTypesSummary objects 云服务资源的详细信息列表。 page_info PageInfo object 分页详细信息。 表4 ResourceTypesSummary 参数 参数类型 描述 region_id String 资源所在区 域名 称。 resource_type String 资源类型名称。 表5 PageInfo 参数 参数类型 描述 previous_marker String 上一页的页面标识。 next_marker String 下一页的页面标识。 current_count Integer 页面数量。
  • 请求示例 根据标签信息查询资源共享实例数量。 POST https://{endpoint}/v1/resource-shares/resource-instances/count { "without_any_tag" : true, "tags" : [ { "key" : "string", "values" : [ "string" ] } ], "matches" : [ { "key" : "string", "value" : "string" } ] }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 表2 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源。 tags 否 Array of TagFilter objects 包含标签,最多包含20个key,每个key下面的value最多20个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含所有标签的资源列表,key之间是"与"的关系,key-value结构中value是"或"的关系。无tag过滤条件时返回全量数据。 matches 否 Array of Match objects 资源共享实例绑定标签列表的匹配字段。 表3 TagFilter 参数 是否必选 参数类型 描述 key 是 String 标签"键"的标识符或名称。 values 否 Array of strings 标签"键"对应的"值"列表。 表4 Match 参数 是否必选 参数类型 描述 key 是 String 键。取值范围为policy , organizational-unit, account。 value 是 String 值。每个值最大长度255个字符。
  • 响应示例 状态码: 200 请求成功。 { "permission" : { "id" : "string", "name" : "string", "resource_type" : "string", "content" : "string", "is_resource_type_default" : true, "created_at" : "2022-08-22T11:40:31.871Z", "updated_at" : "2022-08-22T11:40:31.871Z", "permission_urn" : "string", "permission_type" : "string", "default_version" : false, "version" : 1, "status" : "string" } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 permission Permission object 有关RAM权限的信息。 表5 Permission 参数 参数类型 描述 id String 权限ID。 name String 权限名称。 resource_type String 资源类型。 content String 权限的影响和行为。 is_resource_type_default Boolean 该权限是否是此资源类型的默认权限。 created_at String 权限的创建时间。 updated_at String 最后一次更新权限的时间。 permission_urn String 权限URN。 permission_type String 权限类型。 default_version Boolean 此权限是否为默认版本。 version Integer 权限版本。 status String 权限的状态
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of Untag objects 一个或多个标签键值对的列表。标签键必须存在,而不是空字符串。标签值必须存在,但可以是空字符串。 表4 Untag 参数 是否必选 参数类型 描述 key 是 String 标签"键"的标识符或名称。 value 否 String 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。