Skip to content

Commit 754ff06

Browse files
authored
sdk: rolling update for 0.11.119 (#352)
1 parent 06b9930 commit 754ff06

4 files changed

Lines changed: 64 additions & 39 deletions

File tree

‎ucloud/services/ukms/client.py‎

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,6 @@ def describe_key(self, req: typing.Optional[dict] = None, **kwargs) -> dict:
214214
- **KeyState** (str) - 密钥对外状态。取值:Enabled、Disabled、PendingDeletion、PendingImport、Unavailable。
215215
- **KeyUsage** (list) - 密钥用途。取值:ENCRYPT_DECRYPT、SIGN_VERIFY、GENERATE_VERIFY_MAC、KEY_AGREEMENT。
216216
- **KeyVersion** (int) - 当前密钥版本。
217-
- **OrganizationId** (int) - 密钥所属组织的数字 ID,来源于密钥关联的资源交易记录。
218217
- **Origin** (str) - 密钥材料来源。取值:UCLOUD_KMS、EXTERNAL;当前 CreateKey 仅支持 UCLOUD_KMS。
219218
- **ProjectId** (str) - 密钥所属项目的对外别名,格式为 org-xxx。该值由项目数字 ID 解析得到,可能因项目别名查询失败而为空。
220219
- **ResourceId** (str) - 密钥所属的 UKMS 实例资源 ID。
@@ -419,6 +418,11 @@ def generate_data_key_pair(
419418
420419
**Response**
421420
421+
- **DataPublicKey** (str) - 公钥(明文)。
422+
- **KeyId** (str) - 用于加密私钥的 KMS 密钥
423+
- **KeyPairSpec** (str) - 生成的数据键对类型。
424+
- **PrivateKeyCiphertextBlob** (str) - 私钥的加密副本。
425+
- **PrivateKeyPlaintext** (str) - 私钥的明文副本。
422426
423427
"""
424428
# build request
@@ -445,6 +449,8 @@ def generate_data_key_pair_without_plaintext(
445449
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目,子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
446450
- **Region** (str) - (Config) 地域。 参见 `地域和可用区列表 <https://docs.ucloud.cn/api/summary/regionlist>`_
447451
- **KeyId** (str) - (Required) 密钥ID
452+
- **KeyPairSpec** (str) - (Required) 指定生成的数据密钥对类型。
453+
- **EncryptionContext** (str) - 指定加密私钥时使用的加密上下文。
448454
449455
**Response**
450456
@@ -545,6 +551,7 @@ def generate_random(
545551
546552
**Response**
547553
554+
- **Plaintext** (str) - 随机字节串。
548555
549556
"""
550557
# build request
@@ -722,36 +729,39 @@ def list_keys(self, req: typing.Optional[dict] = None, **kwargs) -> dict:
722729
def list_schedule_deletion_keys(
723730
self, req: typing.Optional[dict] = None, **kwargs
724731
) -> dict:
725-
"""ListScheduleDeletionKeys - 获取计划删除密钥列表,调用ScheduleKeyDeletion命令后进入此列表, 默认30天后正式删除。正式删除前可调用CancelScheduleKeyDeletion恢复
732+
"""ListScheduleDeletionKeys -
726733
727734
**Request**
728735
729-
- **ProjectId** (str) - (Config) 项目ID。不填写为默认项目,子帐号必须填写。 请参考 `GetProjectList接口 <https://docs.ucloud.cn/api/summary/get_project_list>`_
730-
- **Alias** (str) - 按密钥 ID 或别名模糊过滤
731-
- **Limit** (int) - 输出列表数量,默认返回200个
732-
- **Offset** (int) - 输出列表起始位置,默认从0开始
733-
- **OrderBy** (str) - 列表排序方式, 可选项: "-created_time", "created_time","plan_delete_time","-plan_delete_time";默认按-plan_delete_time 计划删除时间升序返回
734-
- **ResourceId** (str) - UKMS 实例资源 ID
735-
- **Sort** (str) - 排序方向,默认 desc
736+
- **ProjectId** (str) - (Config)
737+
- **Alias** (str) -
738+
- **Limit** (int) -
739+
- **Offset** (int) -
740+
- **OrderBy** (str) -
741+
- **ResourceId** (str) -
742+
- **Sort** (str) -
736743
737744
**Response**
738745
739746
- **Objects** (list) - 见 **CMK** 模型定义
740-
- **RequestUuid** (str) - 请求唯一标识符
741-
- **Status** (str) - 操作结果
742-
- **TotalCount** (int) - 符合条件的总数, 不同于Limit
747+
- **RequestUuid** (str) -
748+
- **Status** (str) -
749+
- **TotalCount** (int) -
743750
744751
**Response Model**
745752
746753
**CMK**
747-
- **Alias** (str) - 别名,与CMK一一对应
748-
- **CreatedTime** (int) - 创建时间
749-
- **Description** (str) - 对密钥的描述说明
750-
- **KeyId** (str) - CMK 的唯一标识符
751-
- **KeyType** (str) - 密钥类型,如RSA、EC、DES
752-
- **PlanDeleteTime** (int) - 计划删除时间 时间戳
753-
- **Status** (str) - 密钥状态 "Pre-Active", "Active", "Deactivated", "Compromised", "Destroyed", "Destroyed Compromised"
754-
- **UpdateTime** (int) - 更新时间
754+
- **Alias** (str) -
755+
- **CreatedTime** (int) -
756+
- **Description** (str) -
757+
- **Enabled** (bool) -
758+
- **KeyId** (str) -
759+
- **KeyType** (str) -
760+
- **LastModifiedTime** (int) -
761+
- **PlanDeleteTime** (int) -
762+
- **Status** (str) -
763+
- **Type** (str) -
764+
- **UpdateTime** (int) -
755765
756766
757767
"""
@@ -762,6 +772,9 @@ def list_schedule_deletion_keys(
762772
req and d.update(req)
763773
d = apis.ListScheduleDeletionKeysRequestSchema().dumps(d)
764774

775+
# build options
776+
kwargs["max_retries"] = 0 # ignore retry when api is not idempotent
777+
765778
resp = self.invoke("ListScheduleDeletionKeys", d, **kwargs)
766779
return apis.ListScheduleDeletionKeysResponseSchema().loads(resp)
767780

@@ -941,7 +954,7 @@ def verify(self, req: typing.Optional[dict] = None, **kwargs) -> dict:
941954
return apis.VerifyResponseSchema().loads(resp)
942955

943956
def verify_mac(self, req: typing.Optional[dict] = None, **kwargs) -> dict:
944-
"""VerifyMac - 验证签名
957+
"""VerifyMac - 验证指定消息、HMAC KMS 密钥和 MAC 算法的基于哈希的消息认证码 (HMAC)。为了验证 HMAC,VerifyMac 会使用您指定的消息、HMAC KMS 密钥和 MAC 算法计算 HMAC,并将计算出的 HMAC 与您指定的 HMAC 进行比较。如果两个 HMAC 完全相同,则验证成功;否则,验证失败。 验证结果表明,自计算 HMAC 以来,消息未发生更改,并且使用了指定的密钥来生成和验证 HMAC。
945958
946959
**Request**
947960

‎ucloud/services/ukms/schemas/apis.py‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,17 @@ class GenerateDataKeyPairRequestSchema(schema.RequestSchema):
392392
class GenerateDataKeyPairResponseSchema(schema.ResponseSchema):
393393
"""GenerateDataKeyPair - 创建数据密钥对"""
394394

395-
fields = {}
395+
fields = {
396+
"DataPublicKey": fields.Str(required=False, load_from="DataPublicKey"),
397+
"KeyId": fields.Str(required=False, load_from="KeyId"),
398+
"KeyPairSpec": fields.Str(required=False, load_from="KeyPairSpec"),
399+
"PrivateKeyCiphertextBlob": fields.Str(
400+
required=False, load_from="PrivateKeyCiphertextBlob"
401+
),
402+
"PrivateKeyPlaintext": fields.Str(
403+
required=False, load_from="PrivateKeyPlaintext"
404+
),
405+
}
396406

397407

398408
"""
@@ -406,7 +416,11 @@ class GenerateDataKeyPairWithoutPlaintextRequestSchema(schema.RequestSchema):
406416
"""GenerateDataKeyPairWithoutPlaintext - 创建数据密钥对(无明文返回)"""
407417

408418
fields = {
419+
"EncryptionContext": fields.Str(
420+
required=False, dump_to="EncryptionContext"
421+
),
409422
"KeyId": fields.Str(required=True, dump_to="KeyId"),
423+
"KeyPairSpec": fields.Str(required=True, dump_to="KeyPairSpec"),
410424
"ProjectId": fields.Str(required=False, dump_to="ProjectId"),
411425
"Region": fields.Str(required=True, dump_to="Region"),
412426
}
@@ -498,7 +512,9 @@ class GenerateRandomRequestSchema(schema.RequestSchema):
498512
class GenerateRandomResponseSchema(schema.ResponseSchema):
499513
"""GenerateRandom - 生成随机数"""
500514

501-
fields = {}
515+
fields = {
516+
"Plaintext": fields.Str(required=False, load_from="Plaintext"),
517+
}
502518

503519

504520
"""
@@ -647,12 +663,12 @@ class ListKeysResponseSchema(schema.ResponseSchema):
647663
"""
648664
API: ListScheduleDeletionKeys
649665
650-
获取计划删除密钥列表,调用ScheduleKeyDeletion命令后进入此列表, 默认30天后正式删除。正式删除前可调用CancelScheduleKeyDeletion恢复
666+
651667
"""
652668

653669

654670
class ListScheduleDeletionKeysRequestSchema(schema.RequestSchema):
655-
"""ListScheduleDeletionKeys - 获取计划删除密钥列表,调用ScheduleKeyDeletion命令后进入此列表, 默认30天后正式删除。正式删除前可调用CancelScheduleKeyDeletion恢复"""
671+
"""ListScheduleDeletionKeys -"""
656672

657673
fields = {
658674
"Alias": fields.Str(required=False, dump_to="Alias"),
@@ -666,7 +682,7 @@ class ListScheduleDeletionKeysRequestSchema(schema.RequestSchema):
666682

667683

668684
class ListScheduleDeletionKeysResponseSchema(schema.ResponseSchema):
669-
"""ListScheduleDeletionKeys - 获取计划删除密钥列表,调用ScheduleKeyDeletion命令后进入此列表, 默认30天后正式删除。正式删除前可调用CancelScheduleKeyDeletion恢复"""
685+
"""ListScheduleDeletionKeys -"""
670686

671687
fields = {
672688
"Objects": fields.List(
@@ -860,12 +876,12 @@ class VerifyResponseSchema(schema.ResponseSchema):
860876
"""
861877
API: VerifyMac
862878
863-
验证签名
879+
验证指定消息、HMAC KMS 密钥和 MAC 算法的基于哈希的消息认证码 (HMAC)。为了验证 HMAC,VerifyMac 会使用您指定的消息、HMAC KMS 密钥和 MAC 算法计算 HMAC,并将计算出的 HMAC 与您指定的 HMAC 进行比较。如果两个 HMAC 完全相同,则验证成功;否则,验证失败。 验证结果表明,自计算 HMAC 以来,消息未发生更改,并且使用了指定的密钥来生成和验证 HMAC。
864880
"""
865881

866882

867883
class VerifyMacRequestSchema(schema.RequestSchema):
868-
"""VerifyMac - 验证签名"""
884+
"""VerifyMac - 验证指定消息、HMAC KMS 密钥和 MAC 算法的基于哈希的消息认证码 (HMAC)。为了验证 HMAC,VerifyMac 会使用您指定的消息、HMAC KMS 密钥和 MAC 算法计算 HMAC,并将计算出的 HMAC 与您指定的 HMAC 进行比较。如果两个 HMAC 完全相同,则验证成功;否则,验证失败。 验证结果表明,自计算 HMAC 以来,消息未发生更改,并且使用了指定的密钥来生成和验证 HMAC。"""
869885

870886
fields = {
871887
"KeyId": fields.Str(required=True, dump_to="KeyId"),
@@ -878,7 +894,7 @@ class VerifyMacRequestSchema(schema.RequestSchema):
878894

879895

880896
class VerifyMacResponseSchema(schema.ResponseSchema):
881-
"""VerifyMac - 验证签名"""
897+
"""VerifyMac - 验证指定消息、HMAC KMS 密钥和 MAC 算法的基于哈希的消息认证码 (HMAC)。为了验证 HMAC,VerifyMac 会使用您指定的消息、HMAC KMS 密钥和 MAC 算法计算 HMAC,并将计算出的 HMAC 与您指定的 HMAC 进行比较。如果两个 HMAC 完全相同,则验证成功;否则,验证失败。 验证结果表明,自计算 HMAC 以来,消息未发生更改,并且使用了指定的密钥来生成和验证 HMAC。"""
882898

883899
fields = {
884900
"KeyId": fields.Str(required=False, load_from="KeyId"),

‎ucloud/services/ukms/schemas/models.py‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class KeyMetadataSchema(schema.ResponseSchema):
2121
"KeyVersion": fields.Int(required=True, load_from="KeyVersion"),
2222
"OrganizationId": fields.Int(
2323
required=False, load_from="OrganizationId"
24-
),
24+
), # Deprecated, will be removed at 1.0
2525
"Origin": fields.Str(required=True, load_from="Origin"),
2626
"ProjectId": fields.Str(required=False, load_from="ProjectId"),
2727
"ResourceId": fields.Str(required=True, load_from="ResourceId"),
@@ -74,26 +74,22 @@ class DEKSchema(schema.ResponseSchema):
7474

7575

7676
class CMKSchema(schema.ResponseSchema):
77-
"""CMK - 用户主密钥 (Customer Master Key), 用于生成数据密钥 (Data Encryption Key), 加解密数据密钥."""
77+
"""CMK -"""
7878

7979
fields = {
8080
"Alias": fields.Str(required=True, load_from="Alias"),
8181
"CreatedTime": fields.Int(required=True, load_from="CreatedTime"),
8282
"Description": fields.Str(required=False, load_from="Description"),
83-
"Enabled": fields.Bool(
84-
required=True, load_from="Enabled"
85-
), # Deprecated, will be removed at 1.0
83+
"Enabled": fields.Bool(required=True, load_from="Enabled"),
8684
"KeyId": fields.Str(required=True, load_from="KeyId"),
8785
"KeyType": fields.Str(required=True, load_from="KeyType"),
8886
"LastModifiedTime": fields.Int(
8987
required=True, load_from="LastModifiedTime"
90-
), # Deprecated, will be removed at 1.0
88+
),
9189
"PlanDeleteTime": fields.Int(
9290
required=False, load_from="PlanDeleteTime"
9391
),
9492
"Status": fields.Str(required=True, load_from="Status"),
95-
"Type": fields.Str(
96-
required=True, load_from="Type"
97-
), # Deprecated, will be removed at 1.0
93+
"Type": fields.Str(required=True, load_from="Type"),
9894
"UpdateTime": fields.Int(required=True, load_from="UpdateTime"),
9995
}

‎ucloud/version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version = "0.11.118"
1+
version = "0.11.119"

0 commit comments

Comments
 (0)