查询凭据实例 - ListResourceInstances

resource_instances

是

String

参数解释：

定值为resource_instances

约束限制：

不涉及

取值范围：

定值为resource_instances

默认取值：

不涉及

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

limit

否

String

参数解释：

查询记录数，如果“action”为“filter”，默认为“10”

limit的取值范围为“1-1000”

约束限制：

“action”为“count”时，无需设置此参数

取值范围：

不涉及

默认取值：

不涉及

offset

否

String

参数解释：

索引位置。从offset指定的下一条数据开始查询。查询第一页数据时，将查询前一页数据时响应体中的值带入此参数。如果“action”为“filter”，offset默认为“0”

offset必须为数字，不能为负数

约束限制：

“action”为“count”时，无需设置此参数

取值范围：

不涉及

默认取值：

不涉及

action

是

String

参数解释：

操作标识（可设置为“filter”或者“count”）

• filter：表示过滤

• count：表示查询总条数

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tags

否

Array of Tag objects

参数解释：

标签列表，key和value键值对的集合。最多不超过10个

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

matches

否

Array of TagMatches objects

参数解释：

搜索字段

• key为搜索的字段，目前仅支持搜索凭据名称，值为“resource_name”

• value为模糊匹配的值，最大长度为255个字符。为空返回空值

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

sequence

否

String

参数解释：

请求消息序列号，36字节序列号。例如：919c82d4-8046-4722-9094-35c3c6524cff

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

key

否

String

参数解释：

标签键

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

values

否

Array of strings

参数解释：

标签值集合

最多包含10个value。标签列表中的标签value值不允许重复。标签列表如果为空列表，表示匹配任意值。标签列表中多个value之间是“或”的关系，在key已经满足要求的前提下，满足请求中的某个value就会匹配出来

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

key

否

String

参数解释：

待匹配的字段

约束限制：

只能为凭据资源名称

取值范围：

不涉及

默认取值：

不涉及

value

否

String

参数解释：

标签的值

约束限制：

不涉及

取值范围：

取值范围不超过255个字符，满足正则匹配"^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$"

默认取值：

不涉及

resources

Array of ActionResources objects

参数解释：

资源实例列表，详情请参见resource字段数据结构说明

取值范围：

不涉及

total_count

Integer

参数解释：

总记录数

取值范围：

不涉及

resource_id

String

参数解释：

凭据资源ID

取值范围：

不涉及

resource_detail

Secret object

凭据对象

resource_name

String

参数解释：

资源名称，默认为空字符串

取值范围：

不涉及

tags

Array of TagItem objects

参数解释：

标签列表，没有标签，数组默认为空

参数解释：

不涉及

sys_tags

Array of SysTag objects

参数解释：

系统标签列表，没有标签，数组默认为空

取值范围：

不涉及

id

String

参数解释：

凭据的资源标识符

取值范围：

不涉及

name

String

参数解释：

凭据名称

取值范围：

不涉及

state

String

参数解释：

凭据状态

取值范围：

• ENABLED：表示启用状态

• DISABLED：表示禁用状态

• PENDING_DELETE：表示待删除状态

• FROZEN：表示冻结状态

kms_key_id

String

参数解释：

用于加密凭据值的KMS主密钥的ID值

取值范围：

不涉及

description

String

参数解释：

凭据的描述信息

取值范围：

不涉及

create_time

Long

参数解释：

凭据创建时间，时间戳，即从1970年1月1日至该时间的总秒数

取值范围：

不涉及

update_time

Long

参数解释：

凭据上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数

取值范围：

不涉及

scheduled_delete_time

Long

参数解释：

凭据计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数

凭据不在删除计划中时，本项值为null

取值范围：

不涉及

secret_type

String

参数解释：

凭据类型

取值范围：

• COMMON：通用凭据(默认)。用于应用系统中的各种敏感信息储存

• RDS：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息（已不支持，使用RDS-FG替代）

• RDS-FG：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息

• GaussDB-FG：TaurusDB凭据。专门针对TaurusDB的凭据，用于存储TaurusDB的账号信息

auto_rotation

Boolean

参数解释：

自动轮转

取值范围：

true 开启， false 关闭(默认)

rotation_period

String

参数解释：

轮转周期

取值范围：

4小时-8，760小时 （365天）

rotation_config

String

参数解释：

轮转配置

取值范围：

• 不超过1024个字符

• 当secret_type为RDS-FG、GaussDB-FG时，配置为{"InstanceId":"","SecretSubType":""}

说明：当secret_type为RDS-FG、GaussDB-FG时，必须填写该值

InstanceId为实例ID，SecretSubType为轮转子类型，取值为：SingleUser，MultiUser

SingleUser：指定轮转类型为单用户模式轮转，每次轮转将指定账号重置为新的口令

MultiUser：指定轮转类型为双用户模式轮转，SYSCURRENT和SYSPREVIOUS分别引用其中一个账号。凭据轮转时，SYSPREVIOUS引用的账号口令会被重置为新的随机口令，随后凭据交换SYSCURRENT和SYSPREVIOUS对账号的引用

rotation_time

Long

参数解释：

轮转时间戳

取值范围：

不涉及

next_rotation_time

Long

参数解释：

下一次轮转时间戳

取值范围：

不涉及

last_used_time

Long

参数解释：

最近一次获取凭据值的时间

取值范围：

不涉及

event_subscriptions

Array of strings

参数解释：

凭据订阅的事件列表，当前最大可订阅一个事件。当事件包含的基础事件触发时，通知消息将发送到事件对应的通知主题

取值范围：

不涉及

enterprise_project_id

String

参数解释：

企业项目ID

取值范围：

不涉及

rotation_func_urn

String

参数解释：

FunctionGraph函数的urn

取值范围：

不涉及

domain_id

String

参数解释：

凭据所属的租户的id

取值范围：

不涉及

replica_type

String

参数解释：

多 Region 凭据类型

取值范围：

• STANDALONE：表示当前凭据没有 多Region 副本

• PRIMARY：表示当前凭据有多 Region 副本，当前凭据为主凭据

• REPLICA：表示当前凭据有多 Region 副本，当前凭据为副本凭据

replicas

Array of Replica objects

参数解释：

副本凭据信息

取值范围：

不涉及

id

String

参数解释：

凭据资源标识符

取值范围：

不涉及

kms_key_id

String

参数解释：

用于加密凭据值的KMS密钥的ID

取值范围：

不涉及

project_id

String

参数解释：

凭据所属的 project_id

取值范围：

不涉及

region

String

参数解释：

凭据所属的 region 名称

取值范围：

不涉及

replica_type

String

参数解释：

多 Region 凭据类型

取值范围：

• PRIMARY：当前凭据为主凭据

• REPLICA：当前凭据为副本凭据

status

String

参数解释：

副本凭据同步状态

取值范围：

• IN_PROGRESS：副本凭据待同步

• IN_SYNC：副本与主凭据同步

• FAILED：副本凭据与主凭据同步失败

created_at

Long

参数解释：

创建时间戳

取值范围：

不涉及

updated_at

Long

参数解释：

更新时间戳

取值范围：

不涉及

key

String

参数解释：

标签的名称

约束限制：

• 同一个凭据，一个标签键只能对应一个标签值；不同的凭据可以使用相同的标签键

• 用户最多可以给单个凭据添加20个标签

取值范围：

取值范围为1到128个字符，满足正则匹配"^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)(?<!\s)$"

默认取值：

不涉及

value

String

参数解释：

标签的值

约束限制：

不涉及

取值范围：

取值范围不超过255个字符，满足正则匹配"^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$"

默认取值：

不涉及

key

String

参数解释：

标签键

约束限制：

不涉及

取值范围：

取值范围为1到128个字符，满足正则匹配"^((?!\\s)(?!_sys_)[\\p{L}\\p{Z}\\p{N}_.:=+\\-@]*)(?<!\\s)$"

默认取值：

不涉及

value

String

参数解释：

标签的值

约束限制：

不涉及

取值范围：

取值范围不超过255个字符，满足正则匹配"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$"

默认取值：

不涉及

200

请求已成功